Mokapen API dokumentacija

Opsezi i dopuštenja

Opsezi kontroliraju koje API resurse vaša aplikacija može čitati ili pisati. Svaki opseg ima razinu pristupa povezanu s ulogama članova organizacije.

Metle Razina pristupa Opis Dopuštene uloge
tasks.read Javnost Read tasks owner, user, member, limited_user, guest, admin
tasks.write sjemenke Create or update tasks owner, user, admin
projects.read Javnost Read projects owner, user, member, limited_user, guest, admin
projects.write sjemenke Create or update projects owner, user, admin
appointments.read Javnost Read appointments owner, user, member, limited_user, guest, admin
appointments.write sjemenke Create or update appointments owner, user, admin
bookings.read Javnost Read bookings owner, user, member, limited_user, guest, admin
bookings.write sjemenke Create or update bookings owner, user, admin
contacts.read Javnost Read contact data owner, user, member, limited_user, guest, admin
contacts.write sjemenke Create or update contacts owner, user, admin
companies.read Javnost Read company data owner, user, member, limited_user, guest, admin
companies.write sjemenke Create or update companies owner, user, admin
deals.read Javnost Read deal data owner, user, member, limited_user, guest, admin
deals.write sjemenke Create or update deals owner, user, admin
quotes.read Javnost Read quote data owner, user, member, limited_user, guest, admin
quotes.write sjemenke Create or update quotes owner, user, admin
orders.read Javnost Read order data owner, user, member, limited_user, guest, admin
orders.write sjemenke Create or update orders owner, user, admin
services.read Javnost Read service data owner, user, member, limited_user, guest, admin
services.write sjemenke Create or update services owner, user, admin
products.read Javnost Read product data owner, user, member, limited_user, guest, admin
products.write sjemenke Create or update products owner, user, admin
tickets.read Javnost Read ticket data owner, user, member, limited_user, guest, admin
tickets.write sjemenke Create or update tickets owner, user, admin
documents.read Javnost Read document data owner, user, member, limited_user, guest, admin
documents.write sjemenke Create or update documents owner, user, admin
campaigns.read Javnost Read campaign data owner, user, member, limited_user, guest, admin
campaigns.write sjemenke Create or update campaigns owner, user, admin
profile.write sjemenke Update profile roles and preferences owner, user, admin
users.write sjemenke Manage teams and team members owner, user, admin

Kako opsezi rade

U izradi aplikacije odaberite opsege koje ona može zahtijevati. Tijekom izvođenja, token mora uključivati ​​opseg koji zahtijeva krajnja točka (npr. tasks.read za popis zadataka).

Za javne aplikacije (treće strane), Mokapen također provjerava je li uloga autentificiranog korisnika u organizaciji dopuštena za svaku razinu opsega.

  • Public — dostupno za vlasnika, administratora, korisnika, člana, ograničenog_korisnika i gosta.
  • Polu-ograničeno — dostupno za vlasnika i korisnika.
  • Restricted — dostupno samo za vlasnike (uključuje profile.write i users.write za upravljanje profilom i timom).

Opseg zahtjeva

Javna aplikacija: proslijedite opsege kao popis odvojen razmakom u OAuth autoriziranom URL-u i zahtjevu za token.

Privatne aplikacije: opseg se preuzima iz konfiguracije aplikacije tijekom generiranja tokena.

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

Trebate li pomoć?