Documentação da API Mokapen

Scopes e permissões

Os scopes controlam quais recursos da API o seu aplicativo pode ler ou escrever. Cada scope tem um nível de acesso associado aos papéis dos membros da organização.

Scope Nível de acesso Descrição Papéis permitidos
tasks.read Público Read tasks owner, user, member, limited_user, guest, admin
tasks.write Semi Create or update tasks owner, member, admin
projects.read Público Read projects owner, user, member, limited_user, guest, admin
projects.write Semi Create or update projects owner, member, admin
appointments.read Público Read appointments owner, user, member, limited_user, guest, admin
appointments.write Semi Create or update appointments owner, member, admin
bookings.read Público Read bookings owner, user, member, limited_user, guest, admin
bookings.write Semi Create or update bookings owner, member, admin
contacts.read Público Read contact data owner, user, member, limited_user, guest, admin
contacts.write Semi Create or update contacts owner, member, admin
companies.read Público Read company data owner, user, member, limited_user, guest, admin
companies.write Semi Create or update companies owner, member, admin
deals.read Público Read deal data owner, user, member, limited_user, guest, admin
deals.write Semi Create or update deals owner, member, admin
quotes.read Público Read quote data owner, user, member, limited_user, guest, admin
quotes.write Semi Create or update quotes owner, member, admin
orders.read Público Read order data owner, user, member, limited_user, guest, admin
orders.write Semi Create or update orders owner, member, admin
invoices.read Público Read invoice data owner, user, member, limited_user, guest, admin
invoices.write Semi Create or update invoices owner, member, admin
services.read Público Read service data owner, user, member, limited_user, guest, admin
services.write Semi Create or update services owner, member, admin
products.read Público Read product data owner, user, member, limited_user, guest, admin
products.write Semi Create or update products owner, member, admin
tickets.read Público Read ticket data owner, user, member, limited_user, guest, admin
tickets.write Semi Create or update tickets owner, member, admin
news.read Público Read news posts owner, user, member, limited_user, guest, admin
documents.read Público Read document data owner, user, member, limited_user, guest, admin
documents.write Semi Create or update documents owner, member, admin
campaigns.read Público Read campaign data owner, user, member, limited_user, guest, admin
campaigns.write Semi Create or update campaigns owner, member, admin
presences.read Público Read presence records owner, user, member, limited_user, guest, admin
presences.write Semi Create or update presence records owner, member, admin
shifts.read Público Read shift assignments owner, user, member, limited_user, guest, admin
shifts.write Semi Create or update shift assignments owner, member, admin
timesheets.read Público Read timesheet entries owner, user, member, limited_user, guest, admin
timesheets.write Semi Create or update timesheet entries owner, member, admin
entities.read Público Read custom entity modules owner, user, member, limited_user, guest, admin
entities.write Semi Create or update custom entity modules owner, member, admin
profile.write Semi Update profile roles and preferences owner, member, admin
users.write Semi Manage teams and team members owner, member, admin

Como funcionam os scopes

Na criação do aplicativo você seleciona os scopes que ele pode pedir. Em runtime, o token precisa incluir o scope exigido pelo endpoint (ex. tasks.read para listar as tasks).

Nos aplicativos public (third-party), o Mokapen também verifica se o papel do usuário autenticado na organização é permitido para cada nível de scope.

  • Public — disponível para owner, admin, user, member, limited_user e guest.
  • Semi-restricted — disponível para owner, member e admin.
  • Restricted — disponível só para owner (inclui profile.write e users.write para perfil e gestão da equipe).

Pedir os scopes

App public: passe os scopes como lista separada por espaços na URL OAuth authorize e no pedido de token.

App private: os scopes vêm da configuração do aplicativo na geração do token.

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

Comece a trabalhar economizando tempo.

ou
Agendar uma demo

Preciso de ajuda?