Documentazione API Mokapen

Scope e permessi

Gli scope controllano quali risorse API la tua applicazione può leggere o scrivere. Ogni scope ha un livello di accesso associato ai ruoli dei membri dell'organizzazione.

Scope Livello accesso Descrizione Ruoli consentiti
tasks.read Pubblico Read tasks owner, user, member, limited_user, guest, admin
tasks.write Semi Create or update tasks owner, user, admin
projects.read Pubblico Read projects owner, user, member, limited_user, guest, admin
projects.write Semi Create or update projects owner, user, admin
appointments.read Pubblico Read appointments owner, user, member, limited_user, guest, admin
appointments.write Semi Create or update appointments owner, user, admin
bookings.read Pubblico Read bookings owner, user, member, limited_user, guest, admin
bookings.write Semi Create or update bookings owner, user, admin
contacts.read Pubblico Read contact data owner, user, member, limited_user, guest, admin
contacts.write Semi Create or update contacts owner, user, admin
companies.read Pubblico Read company data owner, user, member, limited_user, guest, admin
companies.write Semi Create or update companies owner, user, admin
deals.read Pubblico Read deal data owner, user, member, limited_user, guest, admin
deals.write Semi Create or update deals owner, user, admin
quotes.read Pubblico Read quote data owner, user, member, limited_user, guest, admin
quotes.write Semi Create or update quotes owner, user, admin
orders.read Pubblico Read order data owner, user, member, limited_user, guest, admin
orders.write Semi Create or update orders owner, user, admin
services.read Pubblico Read service data owner, user, member, limited_user, guest, admin
services.write Semi Create or update services owner, user, admin
products.read Pubblico Read product data owner, user, member, limited_user, guest, admin
products.write Semi Create or update products owner, user, admin
tickets.read Pubblico Read ticket data owner, user, member, limited_user, guest, admin
tickets.write Semi Create or update tickets owner, user, admin
documents.read Pubblico Read document data owner, user, member, limited_user, guest, admin
documents.write Semi Create or update documents owner, user, admin
campaigns.read Pubblico Read campaign data owner, user, member, limited_user, guest, admin
campaigns.write Semi Create or update campaigns owner, user, admin
profile.write Semi Update profile roles and preferences owner, user, admin
users.write Semi Manage teams and team members owner, user, admin

Come funzionano gli scope

In creazione applicazione selezioni gli scope che può richiedere. A runtime, il token deve includere lo scope richiesto dall'endpoint (es. tasks.read per elencare i task).

Per le applicazioni public (third-party), Mokapen verifica anche che il ruolo dell'utente autenticato nell'organizzazione sia consentito per ogni livello scope.

  • Public — disponibile per owner, admin, user, member, limited_user e guest.
  • Semi-restricted — disponibile per owner e user.
  • Restricted — disponibile solo per owner (include profile.write e users.write per profilo e gestione team).

Richiedere gli scope

App public: passa gli scope come lista separata da spazi nell'URL OAuth authorize e nella richiesta token.

App private: gli scope sono presi dalla configurazione applicazione in fase di generazione token.

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

Inizia a lavorare risparmiando tempo.

oppure
Prenota una demo

Hai bisogno di aiuto?