Dokumentasi API Mokapen

Cakupan dan izin

Cakupan mengontrol sumber daya API mana yang dapat dibaca atau ditulis oleh aplikasi Anda. Setiap cakupan memiliki tingkat akses yang terkait dengan peran anggota organisasi.

sapu Tingkat akses Keterangan Peran yang diperbolehkan
tasks.read Publik Read tasks owner, user, member, limited_user, guest, admin
tasks.write Benih Create or update tasks owner, user, admin
projects.read Publik Read projects owner, user, member, limited_user, guest, admin
projects.write Benih Create or update projects owner, user, admin
appointments.read Publik Read appointments owner, user, member, limited_user, guest, admin
appointments.write Benih Create or update appointments owner, user, admin
bookings.read Publik Read bookings owner, user, member, limited_user, guest, admin
bookings.write Benih Create or update bookings owner, user, admin
contacts.read Publik Read contact data owner, user, member, limited_user, guest, admin
contacts.write Benih Create or update contacts owner, user, admin
companies.read Publik Read company data owner, user, member, limited_user, guest, admin
companies.write Benih Create or update companies owner, user, admin
deals.read Publik Read deal data owner, user, member, limited_user, guest, admin
deals.write Benih Create or update deals owner, user, admin
quotes.read Publik Read quote data owner, user, member, limited_user, guest, admin
quotes.write Benih Create or update quotes owner, user, admin
orders.read Publik Read order data owner, user, member, limited_user, guest, admin
orders.write Benih Create or update orders owner, user, admin
services.read Publik Read service data owner, user, member, limited_user, guest, admin
services.write Benih Create or update services owner, user, admin
products.read Publik Read product data owner, user, member, limited_user, guest, admin
products.write Benih Create or update products owner, user, admin
tickets.read Publik Read ticket data owner, user, member, limited_user, guest, admin
tickets.write Benih Create or update tickets owner, user, admin
documents.read Publik Read document data owner, user, member, limited_user, guest, admin
documents.write Benih Create or update documents owner, user, admin
campaigns.read Publik Read campaign data owner, user, member, limited_user, guest, admin
campaigns.write Benih Create or update campaigns owner, user, admin
profile.write Benih Update profile roles and preferences owner, user, admin
users.write Benih Manage teams and team members owner, user, admin

Cara kerja cakupan

Dalam pembuatan aplikasi, pilih cakupan yang dapat diminta. Saat runtime, token harus menyertakan cakupan yang diperlukan oleh titik akhir (misalnya tasks.read untuk membuat daftar tugas).

Untuk aplikasi publik (pihak ketiga), Mokapen juga memeriksa apakah peran pengguna yang diautentikasi dalam organisasi diperbolehkan untuk setiap tingkat cakupan.

  • Publik — tersedia untuk pemilik, admin, pengguna, anggota, pengguna_terbatas, dan tamu.
  • Semi-terbatas — tersedia untuk pemilik dan pengguna.
  • Restricted — hanya tersedia untuk pemilik (termasuk profile.write dan users.write untuk manajemen profil dan tim).

Cakupan permintaan

Publik aplikasi: Meneruskan cakupan sebagai daftar yang dipisahkan spasi di URL otorisasi OAuth dan permintaan token.

Aplikasi pribadi: cakupan diambil dari konfigurasi aplikasi selama pembuatan token.

scope=tasks.read tasks.write contacts.read companies.read

Mulailah bekerja sambil menghemat waktu.

atau
Pesan demo

Apakah Anda memerlukan bantuan?