Dokumentasi API Mokapen

Organisasi

Sebagian besar endpoint Mokapen tercakup dalam satu organisasi. Konteks organisasi ditentukan dalam URL dan token akses.

ID Organisasi di URL

Titik akhir pada entitas mengikuti pola ini:

GET /api/v1/{org_id}/contacts
GET /api/v1/{org_id}/tasks
POST /api/v1/{org_id}/store_contact
Ganti {org_id} dengan ID numerik organisasi Anda. Beberapa integrasi mungkin menggunakan pengidentifikasi organisasi terenkripsi; API menerima kedua format jika didukung.

Batasan organisasi pada token

Token yang diterbitkan untuk aplikasi pengembang mencakup organization_id (disimpan dalam catatan token dan ditampilkan dalam respons OAuth).

Saat Anda memanggil titik akhir dengan {org_id} di URL, Mokapen memverifikasi bahwa token tersebut diotorisasi untuk organisasi tersebut. Jika organisasi di URL tidak cocok dengan organisasi di token, API akan merespons 403 Terlarang.

  • Aplikasi Pribadi — organisasi secara otomatis ditetapkan pada pembuatan token (berdasarkan organisasi aktif di dasbor Pengembang).
  • Aplikasi publik — pengguna akhir memilih organisasi selama persetujuan OAuth.

Titik akhir daftar organisasi

Agar organisasi dapat diakses oleh pengguna atau integrasi yang diautentikasi:

GET /api/v1/organizations

Organisasi premium dan akses API

Ketersediaan API dan kuota harian bergantung pada paket Mokapen organisasi Anda. Lihat Batas API untuk batas per paket.

Apakah Anda memerlukan bantuan?