Como Gerar Token para Integrações API
Introdução
A integração via API com o sistema IXC Provedor é uma solução estratégica para conectar sistemas e automatizar processos de forma segura e escalável. Com ela, é possível estabelecer uma comunicação direta entre aplicações, permitindo o envio e recebimento de dados em tempo real.
Acesso à funcionalidade:
Caminho: Configurações > Usuários > Usuário
Requisitos de Uso
Se você precisa integrar o seu sistema a um outro sistema via API é necessário coletar a URL da API (host) do seu servidor e gerar um Token no sistema. Estes dois dados permitirão a comunicação entre as duas plataformas. Neste documento, vamos mostrar como localizar seu Host, gerar um Token no sistema e quais são os cuidados que você deve ter para garantir a segurança da integração.
Entrega de Valor
- Permite a comunicação direta entre sistemas;
- Facilita a integração com novas ferramentas e plataformas, garantindo um ecossistema digital eficiente e flexível conforme a necessidade da organização.
Como Identificar a URL API (host)
A URL API (host) de um sistema é uma estrutura de endereço que indica o local onde a API está disponível para acesso. No caso da URL https://seudominio/webservice/v1/, o “seudominio” é o nome de domínio do site onde a API está hospedada, o “webservice” é o diretório onde se encontra a API e o “v1” é a versão da API. A partir desse endereço é possível adicionar os demais endpoints responsáveis por retornar as informações sobre as tabelas do sistema.
Importante:
Vale ressaltar que esse endereço funciona apenas para o consumo da API e não possui uma interface visual para ser acessada pelo navegador, retornando apenas um pop-up solicitando os dados de usuário e senha que seriam referentes ao token.
Gerando um Token API
Para gerar um token API, siga as etapas descritas a seguir:
- Acesse menu Configurações > Usuários > Usuário;
- No formulário Usuário, clique em Novo ou Editar, caso já tenha criado um usuário para a integração.
Lembre-se:
É importante que o usuário seja exclusivo para a integração, para que os logs de alterações possam identificar se uma determinada ação foi realizada pelo usuário ou pela integração.
- Após acessar o formulário de criação ou edição de usuários, você deve marcar a opção Permite acesso a API, na seção API. Essa opção é a responsável por gerar o Token utilizado para acessar os recursos do sistema via API. Depois de marcar a opção, clique em Salvar. Após salvar as alterações no formulário, o Token será gerado automaticamente no campo Token de acesso.
Atenção!
O Token está vinculado ao usuário, portanto, se o e-mail ou a senha do usuário forem alterados, o Token também será alterado automaticamente. Além disso, se o grupo de usuários vinculado ao usuário não tiver as permissões necessárias, o Token não poderá acessar os recursos do sistema via API.
Criando um Grupo de Usuários Exclusivo para a Integração API
Para ter um maior controle dos acessos que as integrações conseguem fazer no sistema e dos IPs que podem acessar o sistema via API, é recomendado criar um grupo de usuários exclusivo para as integrações via API. Siga as etapas descritas a seguir:
- Acesse o Menu Configurações > Usuários > Grupo de usuários;
- Na página dos grupos de usuários, clique em Novo ou Duplicar Grupo caso já exista um grupo com as permissões necessárias ou aproximadas.
- Siga para a seção Redes permitidas para realizar a liberação da rede para viabilizar o acesso ao sistema.
- Em seguida, acesse aba de Permissões para definir as permissões do usuário API.
- Clique em Salvar para validar as modificações.
Permissões:
As permissões a serem liberadas devem ser confirmadas com a integração. Confirme com a plataforma a seguir integrada quais são as ações que serão utilizadas no sistema para liberar as permissões adequadas. Caso tenha dúvidas de como alterar as permissões de um grupo de usuários, acesse: Permissões do Grupo de Usuários.
Liberando os IPs para a Integração
As integrações API normalmente solicitam a liberação de um IP para que o servidor onde está hospedado a aplicação tenha permissão de acesso ao sistema. Para liberar os IPs da integração no grupo de usuários, siga:
- Acesse o Menu Configurações.
- Selecione a opção Usuários.
- Em seguida selecione a opção Grupo de Usuários.
- Na página dos grupos de usuários, clique em Editar.
- Siga na seção Permissão de login. No campo Redes permitidas, insira o IP do servidor da aplicação. Lembre-se de separar os IPs por ponto e vírgula (
;). - Clique em Salvar para validar as modificações.
Atenção:
Se você não quiser criar um grupo de usuários exclusivo para a integração, é possível liberar o acesso para os IPs das integrações inserindo-os no grupo de usuários vinculado ao usuário Token. No entanto, será necessário liberar os IPs das integrações e dos seus próprios usuários, para que não haja perda de acesso ao IXC Provedor.
Fluxo de Trabalho
flowchart TD A[Início] --> B[Acessar Configurações] B --> C[Acessar Usuários > Usuários] C --> D{Usuário já existe?} D -- Sim --> E[Editar Usuário] D -- Não --> F[Criar Novo Usuário] E --> G[Marcar Permite acesso a API] F --> G[Marcar Permite acesso a API] G --> H[Salvar Usuário] H --> I[Token Gerado] I --> J{Grupo de Usuário já existe?} J -- Sim --> K[Editar Grupo de Usuário] J -- Não --> L[Criar ou Duplicar Grupo] K --> M[Verificar/Conceder Permissões] L --> M[Definir Permissões conforme integração] M --> N[Inserir IPs permitidos] N --> O[Fim]
Considerações Finais
Gerar um Token para integrações API é um processo simples, mas é importante ter cuidado para garantir a segurança da integração. Criar um usuário exclusivo, um grupo de usuários com permissões adequadas e controlar os IPs de acesso são medidas essenciais para proteger o sistema e as informações dos usuários.
Etiquetas
API IntegracoesAPI GrupoDeUsuarios
