Mokapen API dokumentation

Omfattningar och behörigheter

Scopes styr vilka API-resurser din applikation kan läsa eller skriva. Varje scope har en åtkomstnivå kopplad till organisationsmedlemsroller.

Kvastar Åtkomstnivå Beskrivning Tillåtna roller
tasks.read Offentlig Read tasks owner, user, member, limited_user, guest, admin
tasks.write Frön Create or update tasks owner, user, admin
projects.read Offentlig Read projects owner, user, member, limited_user, guest, admin
projects.write Frön Create or update projects owner, user, admin
appointments.read Offentlig Read appointments owner, user, member, limited_user, guest, admin
appointments.write Frön Create or update appointments owner, user, admin
bookings.read Offentlig Read bookings owner, user, member, limited_user, guest, admin
bookings.write Frön Create or update bookings owner, user, admin
contacts.read Offentlig Read contact data owner, user, member, limited_user, guest, admin
contacts.write Frön Create or update contacts owner, user, admin
companies.read Offentlig Read company data owner, user, member, limited_user, guest, admin
companies.write Frön Create or update companies owner, user, admin
deals.read Offentlig Read deal data owner, user, member, limited_user, guest, admin
deals.write Frön Create or update deals owner, user, admin
quotes.read Offentlig Read quote data owner, user, member, limited_user, guest, admin
quotes.write Frön Create or update quotes owner, user, admin
orders.read Offentlig Read order data owner, user, member, limited_user, guest, admin
orders.write Frön Create or update orders owner, user, admin
services.read Offentlig Read service data owner, user, member, limited_user, guest, admin
services.write Frön Create or update services owner, user, admin
products.read Offentlig Read product data owner, user, member, limited_user, guest, admin
products.write Frön Create or update products owner, user, admin
tickets.read Offentlig Read ticket data owner, user, member, limited_user, guest, admin
tickets.write Frön Create or update tickets owner, user, admin
documents.read Offentlig Read document data owner, user, member, limited_user, guest, admin
documents.write Frön Create or update documents owner, user, admin
campaigns.read Offentlig Read campaign data owner, user, member, limited_user, guest, admin
campaigns.write Frön Create or update campaigns owner, user, admin
profile.write Frön Update profile roles and preferences owner, user, admin
users.write Frön Manage teams and team members owner, user, admin

Hur scopes fungerar

När du skapar applikationer väljer du de omfattningar som den kan begära. Vid körning måste token inkludera det omfång som krävs av slutpunkten (t.ex. tasks.read för att lista uppgifter).

För offentliga (tredje parts) applikationer kontrollerar Mokapen även att den autentiserade användarens roll i organisationen är tillåten för varje scope-nivå.

  • Public — tillgängligt för ägare, administratör, användare, medlem, begränsad_användare och gäst.
  • Halvbegränsad — tillgängligt för ägare och användare.
  • Restricted — endast tillgängligt för ägare (inkluderar profile.write och users.write för profil- och teamhantering).

Begär omfattningar

App offentlig: Passera omfång som en blankstegsseparerad lista i OAuth-begäran för auktorisering av URL och token.

Privata appar: omfattningar tas från applikationskonfigurationen under tokengenerering.

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

Börja arbeta samtidigt som du sparar tid.

eller
Boka en demo

Behöver du hjälp?