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-restritto Create or update tasks owner, user
projects.read Pubblico Create or update projects owner, user, member, limited_user, guest, admin
projects.write Semi-restritto Create or update tasks owner, user
appointmets.read Pubblico Create or update appointments owner, user, member, limited_user, guest, admin
appointmets.write Semi-restritto Create or update appointments owner, user
contacts.read Pubblico Read contact data owner, user, member, limited_user, guest, admin
contacts.write Riservato Create or update contacts owner
companies.read Pubblico Read company data owner, user, member, limited_user, guest, admin
companies.write Riservato Create or update companies owner
deals.read Pubblico Read deal data owner, user, member, limited_user, guest, admin
deals.write Riservato Create or update deals owner
quotes.read Pubblico Read quote data owner, user, member, limited_user, guest, admin
quotes.write Riservato Create or update quotes owner
orders.read Pubblico Read order data owner, user, member, limited_user, guest, admin
orders.write Riservato Create or update orders owner
services.read Pubblico Read service data owner, user, member, limited_user, guest, admin
services.write Riservato Create or update services owner
products.read Pubblico Read product data owner, user, member, limited_user, guest, admin
products.write Riservato Create or update products owner
tickets.read Pubblico Read tickets data owner, user, member, limited_user, guest, admin
tickets.write Riservato Create or update tickets owner
documents.read Pubblico Read document data owner, user, member, limited_user, guest, admin
campaigns.read Pubblico Read campaign data owner, user, member, limited_user, guest, 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.

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?