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 no card EVO é apresentada a tela:

1. Lista em ordem alfabética com todos os Tokens de integração criados.
2. Campo de pesquisa para buscar pelo nome do Token
3. NOVO TOKEN: botão para criar novos Tokens.
4. Ações: edita e exclui os Tokens criados.
5. Histórico de exclusão dos Tokens.

📘

Leia este artigo para saber como criar um novo token.

Para visualizar ou editar as permissões de um token já existente, clique no nome do token ou no ícone de "editar".

A partir disso, você pode adicionar ou remover as permissões clicando na seta para expandir e visualizar os endpoints referidos.

As permissões selecionadas devem estar relacionadas aos dados que a chave poderá acessar.

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:

• Get activities: Permite obter uma lista de atividades disponíveis.
• Get activities schedule: Permite obter o cronograma das atividades registradas.
• Get activities schedule details: Permite obter os detalhes do cronograma de atividades registradas.
• List of spots that are already filled in the activity session: Permite obter uma lista das vagas já preenchidas para a atividade.

Atividade - Edição:

• Enroll member in activity schedule: Permite matricular um cliente no cronograma de atividades.
• Change status of a member in activity schedule: Permite mudar o status de um cliente no cronograma de atividades.
• Create a new trial class and enroll the member on it: Permite criar uma aula teste e matricular um cliente nela.

BankAccounts

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

Configuração - Consulta:

• Get bank accounts: Permite obter uma lista das contas bancárias.

Configuration

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

Configuração - Consulta:

• Get branch configurations: Permite obter uma lista das configurações da unidade.
• Get gateway configurations: Permite obter uma lista das configurações de gateway.
• Get card flag: Permite obter uma lista das bandeiras de cartão.
• Get card translation: Permite obter uma lista das traduções de cartão.

Controle Acesso - Consulta

• Get occupation: Permite obter a ocupação da unidade.

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

• Add employees: Permite cadastrar colaboradores.
• Update employees: Permite atualizar colaboradores cadastrados.
• Delete employees: Permite excluir colaboradores cadastrados.

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

• Get invoices by date: Permite obter notas fiscais por data.

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

• Get non-renewed clients: Permite obter lista de clientes não renovados.
• Get prospects: Permite obter lista de oportunidades.
• Get active clients: Permite obter lista de clientes ativos.

MemberMembership

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

Contratos de Clientes - Consulta

• Get summary of MemberMemberships by ID: Permite obter resumo de contratos de alunos por ID.
• Get summary of canceled MemberMemberships: Permite obter resumo de contratos de alunos cancelados.

Contratos de Clientes - Edição

• Cancel MemberMembership: Permite cancelar contratos de alunos.

Members

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

Cliente - Consulta

• Get member profile: Permite obter perfis de cliente.
• Get members: Permite obter lista de clientes.
• Get password reset link: Permite obter o link de redefinição de senha.
• Get member's fitcoins: Permite obter o número de fitcoins dos alunos.

Cliente - Consulta sem dados sensíveis

• Get basic member information: Permite obter informações básicas do cliente.

Cliente - Edição

• Update a member card number: Permite atualizar o número de cartão de cliente cadastrado.
• Authenticate member: Permite criar o acesso do cliente.
• Update a member's fitcoins: Permite atualizar o número de fitcoins dos clientes.
• Update basic member data: Permite atualizar os dados básicos do cliente.

Memberships

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

Contratos - Consulta:

• Get Memberships: Permite obter uma lista dos contratos dos clientes.
• Get Memberships categories: Permite obter as categorias de contratos dos alunos.

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:

• Insert a member notification Permite inserir uma notificação sobre o cliente.

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

• Get prospects: Permite obter lista de oportunidades.

Oportunidade - Edição

• Add prospects: Permite adicionar oportunidades.
• Update prospect: Permite atualizar uma oportunidade.

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

• Get receivables: Permite obter informações as contas a receber.

Contas Receber - Edição

• Mark as received: Permite marcar contas como recebidas.
• Get cost center: Permite obter informações sobre o centro de custos de contas a receber.

Sales

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

Vendas - Consulta

• Get sales: Permite obter lista de vendas.
• Get sale by ID: Permite obter informações sobre venda por ID.
• Get sales by sessionID: Permite obter vendas por sessionID.

Vendas - Edição

• Create a new sale: Permite criar uma nova venda.
• Return itens by sale: Permite retornar itens por venda em site/totem.

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

• Get services: Permite obter uma lista de serviços.

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

• List all webhooks created: Permite obter uma lista de todos os webhooks criados para a unidade.

Webhooks - Edição

• Add new webhook: Permite criar webhooks para que o EVO notifique sistemas externos sempre que um determinado evento ocorrer.
• Remove a specific webhook by ID: Permite remover um webhook específico por ID.

Workout

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

Treinos - Consultar

• Get all default workouts: Permite obter uma lista completa de treinos-padrão.
• Get all client or prospect or employee's workouts: Permite obter uma lista de todos os treinos de um cliente, oportunidade ou colaborador.
• Get all client or prospect or employee's workouts by month, year or idProfessor: Permite obter uma lista de todos os treinos de um cliente, oportunidade ou colaborador por mês, ano ou idProfessor.

Treinos - Editar

• Link workout to client: Permite ligar um treino a um cliente.
• Change data of a client's assigned workout: Permite atualizar dados de um treino prescrito a um cliente.