Como obter as credenciais necessárias para integração via API Gateway?

Para realizar integrações com o Sankhya utilizando a API Gateway, é necessário obter três credenciais essenciais: "Client ID", "Client Secret" e "X-Token". Essas chaves garantem a autenticação segura via OAuth 2.0 e permitem que sistemas externos se comuniquem corretamente com o ERP.

Este artigo orienta sobre como gerar cada uma dessas credenciais e como utilizá-las corretamente no processo de autenticação.

Credenciais necessárias para integração

Para a integração correta com a API Gateway, são necessárias três chaves distintas, cada uma obtida em locais específicos:

• "Client ID": gerado no Portal do Desenvolvedor
• "Client Secret": gerado no Portal do Desenvolvedor
• "X-Token": gerado na tela "Configurações do Gateway" (Configurações Avançado Configurações do Gateway)
 

É importante destacar que o "X-Token" utilizado na integração é exclusivamente o token gerado na tela de Configurações do Gateway.

Como gerar as credenciais

Siga os passos abaixo na ordem indicada para criar uma nova integração e obter todas as credenciais necessárias:

Acesse a documentação oficial "Como iniciar uma integração com a Sankhya" e siga as orientações para criar uma nova solução no Portal do Desenvolvedor. Neste processo, serão gerados o "Client ID" e o "Client Secret".

Consulte a documentação a seguir para configurar as permissões necessárias aos usuários que utilizarão a integração. "Concedendo acesso a colaboradores" 

Acesse a documentação "Gerando tokens de integração no SankhyaOM" e siga as instruções para gerar o "X-Token" na tela "Configurações do Gateway" (Configurações Avançado Configurações do Gateway).

Estrutura correta da requisição de autenticação

Após obter as três credenciais, utilize a estrutura abaixo para realizar a autenticação via OAuth 2.0 e gerar o Bearer Token:

curl --location 'https://api.sankhya.com.br/gateway/v1/authenticate' /
--header 'X-Token:{SEU_X_TOKEN}' \
--header 'accept: application/x-www-form-urlencoded' \
--header 'content-type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic {client_id:client_secret em base64}' /
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id={SEU_CLIENT_ID}' \
--data-urlencode 'client_secret={SEU_CLIENT_SECRET}'

Substitua {SEU_X_TOKEN}, {SEU_CLIENT_ID} e {SEU_CLIENT_SECRET} pelas credenciais geradas anteriormente.

Pontos de atenção importantes

• Correspondência entre credenciais: o erro mais comum ocorre quando são utilizados "Client ID" e "Client Secret" de uma aplicação, mas o "X-Token" de outra. Certifique-se de que todas as três credenciais pertençam ao mesmo componente vinculada na tela "Configurações do Gateway" (Configurações >> Avançado >> Configurações Gateway).

• Ambiente correto: Atente-se ao ambiente utilizado (teste ou produção), garantindo que as chaves correspondam à base correta. Utilize o endpoint de produção https://api.sankhya.com.br/gateway/v1/authenticate para ambientes de produção e o endpoint Sandbox (Teste) https://api.sandbox.sankhya.com.br/gateway/v1/authenticate para ambientes de homologação/teste.

• Validação da requisição: Você pode utilizar a própria tela de testes da documentação da API para validar a geração do Bearer Token antes de implementar na aplicação final.