Permissões do token

Ao criar uma chave/token de autenticação, você deve escolher quais endpoints ele poderá chamar.

Introdução

No ato de criação das chaves necessárias para realizar solicitação de API diretamente no EVO, em Configurações - Integrações, é importante entender que há dois tipos de chaves de API possíveis de serem criadas:

  • Chave única de filial: chave criada na instância de uma filial com permissões e acesso somente a dados daquela filial;
  • Chave multifilial: chave criada em uma instância de ADM Geral com acesso somente a chamadas que possuem o parâmetro idbranch.

Em Configurações - Integrações, acesse o card EVO na seção API:

Ao clicar, um modal lateral abrirá pedindo que você nomeie a chave e escolha as permissões dela. As permissões são relacionadas aos endpoints de cada entidade da EVO API.

🚧

Uma vez criada a chave, ela não é editável, sendo necessário criar outra caso queira ter permissões distintas.

Neste artigo, vamos explorar cada uma dessas permissões e quais endpoints elas permitem chamada, a fim de que você possa criar tokens de autenticação que sirvam às necessidades de cada usuário de API do seu negócio.

Permissões por entidade

Listaremos abaixo as permissões por entidade e seus respectivos endpoints e função.

Activities

Esta entidade se refere às atividades ("aulas") que são marcadas e às quais os clientes se matriculam. As permissões e os endpoints que acessam são:

Atividade - Consulta:

Atividade - Edição:

BankAccounts

Esta entidade se refere às contas bancárias. As permissões e os endpoints que acessam são:

Configuração - Consulta:

Configuration

Esta entidade se refere às configurações de uma unidade. As permissões e os endpoints que acessam são:

Configuração - Consulta:

Controle Acesso - Consulta

Employees

Esta entidade se refere aos colaboradores de uma unidade. As permissões e os endpoints que acessam são:

Colaboradores - Consulta:

  • Get employees: Permite obter uma lista dos colaboradores cadastrados.

Colaboradores - Edição

Entries

Esta entidade se refere às entradas de clientes em uma unidade. As permissões e os endpoints que acessam são:

Entradas - Consulta:

  • Get entries: Permite obter uma lista das entradas na unidade.

Invoices

Esta entidade se refere às entradas de clientes em uma unidade. As permissões e os endpoints que acessam são:

Notas Fiscais - Consulta

Management

Esta entidade se refere à gestão de clientes e oportunidades. As permissões e os endpoints que acessam são:

Cliente - Consulta sem dados sensíveis

MemberMembership

Esta entidade se refere aos contratos de clientes. As permissões e os endpoints que acessam são:

Contratos de Clientes - Consulta

Contratos de Clientes - Edição

Members

Esta entidade se refere aos clientes registrados em uma unidade. As permissões e os endpoints que acessam são:

Cliente - Consulta

Cliente - Consulta sem dados sensíveis

Cliente - Edição

Memberships

Esta entidade se refere aos contratos registrados em uma unidade. As permissões e os endpoints que acessam são:

Contratos - Consulta:

Notifications

Esta entidade se refere às notificações sobre um cliente. As permissões e os endpoints que acessam são:

Notificações - Edição:

Payables

Esta entidade se refere às contas a pagar de uma unidade. As permissões e os endpoints que acessam são:

Contas Pagar - Consulta

  • Get payables: Permite obter as contas a pagar.
  • Get cost center: Permite obter informações sobre o centro de custos de contas a pagar.

Prospects

Esta entidade se refere às oportunidades de uma unidade. As permissões e os endpoints que acessam são:

Oportunidade - Consulta

Oportunidade - Edição

Receivables

Esta entidade se refere às contas a receber de uma unidade. As permissões e os endpoints que acessam são:

Contas Receber - Consulta

Contas Receber - Edição

Sales

Esta entidade se refere às vendas de uma unidade. As permissões e os endpoints que acessam são:

Vendas - Consulta

Vendas - Edição

Service

Esta entidade se refere aos serviços cadastrados em uma unidade. As permissões e os endpoints que acessam são:

Serviços - Consulta

Voucher

Esta entidade se refere aos vouchers cadastrados em uma unidade. As permissões e os endpoints que acessam são:

Voucher - Consulta

  • Get vouchers: Permite obter uma lista dos vouchers cadastrados.

Webhook

Esta entidade se refere aos webhooks de uma unidade. As permissões e os endpoints que acessam são:

Webhooks - Consulta

Webhooks - Edição

Workout

Esta entidade se refere a treinos de uma unidade. As permissões e os endpoints que acessam são:

Treinos - Consultar

Treinos - Editar