Mokapen API-documentatie

Bereik en machtigingen

Scopes bepalen welke API-bronnen uw toepassing kan lezen of schrijven. Elk bereik heeft een toegangsniveau dat is gekoppeld aan de rollen van organisatieleden.

Bezems Toegangsniveau Beschrijving Toegestane rollen
tasks.read Openbaar Read tasks owner, user, member, limited_user, guest, admin
tasks.write Zaden Create or update tasks owner, user, admin
projects.read Openbaar Read projects owner, user, member, limited_user, guest, admin
projects.write Zaden Create or update projects owner, user, admin
appointments.read Openbaar Read appointments owner, user, member, limited_user, guest, admin
appointments.write Zaden Create or update appointments owner, user, admin
bookings.read Openbaar Read bookings owner, user, member, limited_user, guest, admin
bookings.write Zaden Create or update bookings owner, user, admin
contacts.read Openbaar Read contact data owner, user, member, limited_user, guest, admin
contacts.write Zaden Create or update contacts owner, user, admin
companies.read Openbaar Read company data owner, user, member, limited_user, guest, admin
companies.write Zaden Create or update companies owner, user, admin
deals.read Openbaar Read deal data owner, user, member, limited_user, guest, admin
deals.write Zaden Create or update deals owner, user, admin
quotes.read Openbaar Read quote data owner, user, member, limited_user, guest, admin
quotes.write Zaden Create or update quotes owner, user, admin
orders.read Openbaar Read order data owner, user, member, limited_user, guest, admin
orders.write Zaden Create or update orders owner, user, admin
services.read Openbaar Read service data owner, user, member, limited_user, guest, admin
services.write Zaden Create or update services owner, user, admin
products.read Openbaar Read product data owner, user, member, limited_user, guest, admin
products.write Zaden Create or update products owner, user, admin
tickets.read Openbaar Read ticket data owner, user, member, limited_user, guest, admin
tickets.write Zaden Create or update tickets owner, user, admin
documents.read Openbaar Read document data owner, user, member, limited_user, guest, admin
documents.write Zaden Create or update documents owner, user, admin
campaigns.read Openbaar Read campaign data owner, user, member, limited_user, guest, admin
campaigns.write Zaden Create or update campaigns owner, user, admin
profile.write Zaden Update profile roles and preferences owner, user, admin
users.write Zaden Manage teams and team members owner, user, admin

Hoe scopes werken

Selecteer bij het maken van de toepassing de bereiken die kunnen worden aangevraagd. Tijdens runtime moet het token de reikwijdte omvatten die vereist is door het eindpunt (bijvoorbeeld tasks.read om taken weer te geven).

Voor publieke (derden)applicaties controleert Mokapen bovendien per scopeniveau of de rol van de geauthenticeerde gebruiker in de organisatie is toegestaan.

  • Openbaar — beschikbaar voor eigenaar, beheerder, gebruiker, lid, beperkte_gebruiker en gast.
  • Semi-beperkt — beschikbaar voor eigenaar en gebruiker.
  • Restricted — alleen beschikbaar voor eigenaren (inclusief profile.write en users.write voor profiel- en teambeheer).

Bereik aanvragen

App openbaar: geef bereiken door als een door spaties gescheiden lijst in de OAuth-autorisatie-URL en tokenaanvraag.

Privé-apps: bereiken worden tijdens het genereren van tokens uit de applicatieconfiguratie gehaald.

scope=taken.lees taken.schrijf contacten.lees bedrijven.lees

Begin met werken en bespaar tijd.

of
Boek een demo

Heeft u hulp nodig?