MMyPlanDokumentasi
Integrasi

REST API

Pakai MyPlan dari skrip, CI, dan aplikasi Anda sendiri dengan token workspace atau token akun.

REST API MyPlan memberi akses yang sama dengan aplikasi web ke proyek, tugas, komentar, status, label, siklus, modul, halaman, file, catatan waktu, dan webhook. Referensi lengkap setiap endpoint, dengan contoh cURL, JavaScript, dan Python, ada di Referensi REST API. Dokumen OpenAPI 3.1 bisa diunduh dari https://myplan.my.id/v1/openapi.json.

Memakai API di sebuah workspace membutuhkan paket yang mencakup Token API (paket Team ke atas).

Token

TokenAwalanTempat membuatJangkauan
Token workspacemp_Pengaturan workspace → CI & GitHubSatu workspace
Token akunmpa_Akun → Token APISemua workspace tempat Anda menjadi anggota

Kedua jenis token bertindak dengan izin Anda sendiri. Token tidak bisa mengelola token, akun, atau cara masuk, dan tidak bisa menghapus workspace.

Kirim token di header Authorization:

curl https://myplan.my.id/v1/token-info \
  -H "Authorization: Bearer $MYPLAN_TOKEN"

Scope

Setiap token punya scope read, dan opsional write. Permintaan GET cukup dengan read; metode lain membutuhkan write. Tanpa write, API menjawab 403 forbidden.

Paginasi

Daftar tugas (GET /projects/{id}/tasks) memakai limit (bawaan 100, paling banyak 500) dan cursor. Jawabannya berisi items, total, dan nextCursor; ulangi permintaan dengan cursor=nextCursor sampai nilainya null.

Galat

Setiap galat memakai bentuk yang sama:

{ "error": { "code": "not_found", "message": "not found" } }
StatusKodeArti
400beragam, misalnya invalid_titleIsi permintaan tidak valid
401unauthenticatedToken tidak ada, salah, kedaluwarsa, atau dicabut
402plan_requiredPaket workspace tidak mencakup fitur ini
403forbiddenPeran Anda atau scope token tidak mengizinkan
404not_foundTidak ada, atau Anda tidak boleh melihatnya
429rate_limitedTerlalu banyak permintaan

Batas laju

Setiap token boleh membuat 600 permintaan per menit (bawaan; server self-hosted bisa mengubahnya). Lewat dari itu API menjawab 429; tunggu sampai menit berikutnya.

Webhook

Untuk menerima perubahan alih-alih menanyakannya terus-menerus, gunakan webhook. Bentuk isi dan tanda tangannya juga dijelaskan di referensi API.

Terkait

Di halaman ini