Dokumentasi API Mokapen

Untuk memulai

Sebelum memanggil titik akhir API apa pun, buat dan konfigurasikan aplikasi di akun Pengembang Mokapen Anda.

Ringkasan

API Mokapen adalah REST. Setiap permintaan harus menyertakan header Authorization: Bearer yang valid, kecuali dinyatakan sebaliknya.

URL Dasar: https://mokapen.com/api

Awalan versi API: v1 (contoh: /api/v1/{org_id}/contacts).

Langkah 1 — Buat aplikasi

Masuk ke Mokapen, buka organisasi Anda dan buka Akun → Pengembang → Aplikasi Saya. Dari sana Anda dapat melihat aplikasi yang ada atau membuat aplikasi baru.

Mokapen mendukung dua jenis aplikasi:

  • App public — dirancang untuk integrasi yang digunakan oleh banyak pengguna Mokapen. Gunakan alur kode otorisasi OAuth 2.0. Pengguna memberi otorisasi pada aplikasi Anda dan memilih organisasi mana yang akan diberi akses.
  • Aplikasi pribadi — dirancang untuk otomatisasi internal dalam organisasi Anda. Gunakan hibah client_credentials. Token dihasilkan dari dasbor Pengembang tanpa pengalihan OAuth ke pengguna akhir.

Persyaratan aplikasi

Bidang Aplikasi publik Aplikasi pribadi
Nama perusahaan Wajib Wajib
Situs web perusahaan Wajib Wajib
Nama aplikasi Wajib Wajib
Logo perusahaan Wajib Wajib
URL pengalihan Wajib Tidak diperlukan
Pengguna yang berdedikasi Tidak diperlukan Wajib
Pemangku kepentingan Opsional Opsional
Untuk aplikasi pribadi, kolom Pengguna Khusus menentukan anggota organisasi mana yang diwakili oleh integrasi. Akses API menghormati izin dan cakupan pengguna tersebut.

Langkah 2 — Pilih cakupan API

Setelah mengisi data aplikasi, klik Lanjutkan untuk memilih cakupan (izin) yang diperlukan, lalu simpan aplikasi.

Hanya cakupan yang diaktifkan selama penyiapan yang dapat diminta dalam otorisasi (aplikasi publik) atau disertakan dalam token (aplikasi pribadi).

Langkah 3 — Aktivasi dan kredensial

aplikasi pribadi diaktifkan segera setelah pembuatan. Pemilik dan admin organisasi dapat menonaktifkan atau mengaktifkannya kembali kapan saja dari halaman aplikasi.

publik permohonan dimulai sebagai Menunggu Persetujuan. Mokapen meninjau cakupan yang diperlukan sebelum mengaktifkan aplikasi. Ketika statusnya adalah Active, buka tab Credentials untuk mendapatkan client_id dan client_secret dan memulai aliran kode otorisasi OAuth.

Jika Anda mengubah cakupan pada aplikasi publik yang sudah aktif, aplikasi tersebut akan kembali menunggu persetujuan dan token yang ada akan dicabut.

Simpan kredensial Anda dengan aman. Jangan pernah mengekspos rahasia klien dalam kode sisi klien atau di repositori publik.

Langkah selanjutnya

Apakah Anda memerlukan bantuan?