Mokapen API dokumentation

Omfang og tilladelser

Scopes styrer, hvilke API-ressourcer din applikation kan læse eller skrive. Hvert omfang har et adgangsniveau knyttet til organisationsmedlemsroller.

Koste Adgangsniveau Beskrivelse Tilladte roller
tasks.read Offentlig Read tasks owner, user, member, limited_user, guest, admin
tasks.write Frø Create or update tasks owner, user, admin
projects.read Offentlig Read projects owner, user, member, limited_user, guest, admin
projects.write Frø Create or update projects owner, user, admin
appointments.read Offentlig Read appointments owner, user, member, limited_user, guest, admin
appointments.write Frø Create or update appointments owner, user, admin
bookings.read Offentlig Read bookings owner, user, member, limited_user, guest, admin
bookings.write Frø Create or update bookings owner, user, admin
contacts.read Offentlig Read contact data owner, user, member, limited_user, guest, admin
contacts.write Frø Create or update contacts owner, user, admin
companies.read Offentlig Read company data owner, user, member, limited_user, guest, admin
companies.write Frø Create or update companies owner, user, admin
deals.read Offentlig Read deal data owner, user, member, limited_user, guest, admin
deals.write Frø Create or update deals owner, user, admin
quotes.read Offentlig Read quote data owner, user, member, limited_user, guest, admin
quotes.write Frø Create or update quotes owner, user, admin
orders.read Offentlig Read order data owner, user, member, limited_user, guest, admin
orders.write Frø Create or update orders owner, user, admin
services.read Offentlig Read service data owner, user, member, limited_user, guest, admin
services.write Frø Create or update services owner, user, admin
products.read Offentlig Read product data owner, user, member, limited_user, guest, admin
products.write Frø Create or update products owner, user, admin
tickets.read Offentlig Read ticket data owner, user, member, limited_user, guest, admin
tickets.write Frø Create or update tickets owner, user, admin
documents.read Offentlig Read document data owner, user, member, limited_user, guest, admin
documents.write Frø Create or update documents owner, user, admin
campaigns.read Offentlig Read campaign data owner, user, member, limited_user, guest, admin
campaigns.write Frø Create or update campaigns owner, user, admin
profile.write Frø Update profile roles and preferences owner, user, admin
users.write Frø Manage teams and team members owner, user, admin

Hvordan scopes fungerer

I applikationsoprettelse skal du vælge de omfang, den kan anmode om. Ved kørsel skal tokenet omfatte det omfang, der kræves af slutpunktet (f.eks. tasks.read for at vise opgaver).

For offentlige (tredjeparts) applikationer kontrollerer Mokapen også, at den autentificerede brugers rolle i organisationen er tilladt for hvert omfangsniveau.

  • Public — tilgængelig for ejer, admin, bruger, medlem, limited_user og gæst.
  • Semi-restricted — tilgængelig for ejer og bruger.
  • Restricted — kun tilgængelig for ejere (inkluderer profile.write og users.write til profil- og teamledelse).

Anmod om omfang

App offentlig: Angiv omfang som en mellemrumssepareret liste i OAuth-godkender URL- og tokenanmodning.

Private apps: omfang tages fra applikationskonfigurationen under tokengenerering.

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

Begynd at arbejde, mens du sparer tid.

eller
Book en demo

Har du brug for hjælp?