Logística - TOTVS Coleta Entrega - Coleta Entrega - Autenticação de APIs da Suite Logística via Postman

Tempo aproximado para leitura: 00:02:35 min

Dúvida
Como realizar a autenticação nas APIs da Suite Logística TOTVS via Postman? 

Ambiente
TOTVS Logística - TOTVS Coleta Entrega - Coleta Entrega - Todas as versões

Solução
Os produtos de transporte da Suíte Logística TOTVS possuem APIs protegidas por autenticação e autorização baseadas no padrão de mercado OAuth2.

Para obter um token de acesso e realizar integrações, siga os passos abaixo:

1. No aplicativo Postman, acesse as configurações e desabilite a opção SSL certificate verification;
2. Clique em New e selecione a opção Collection para criar uma nova requisição.
3. Nomeie a coleção e salve. Exemplo: Autenticação.
4. Na aba Authorization, altere o Auth Type para OAuth 2.0 e defina o campo Add authorization data to como Request Headers;
5. Na seção Configure New Token, preencha os parâmetros da seguinte forma:
   • Token name: Defina um nome de sua escolha.
   • Grant type: Selecione Client Credentials.
   • Access Token URL: Preencha com https://[tenant].rac.totvs.app/totvs.rac/connect/token, e substitua [tenant] pelo nome do seu ambiente.
   • Client ID e Client Secret: Insira suas credenciais M2M geradas no ambiente.
   • Scope: Preencha com authorization_api.
   • Client Authentication: Selecione Send as Basic Auth header.

6. Clique no botão Get New Access Token.

7. Se os dados estiverem corretos, o token será gerado com sucesso. A partir disso, você poderá realizar requisições para o portal conforme a documentação específica de cada produto.

Importante
Autenticação por Usuário: Em APIs que dependem de privilégios de acesso de um usuário específico, altere o Grant type para Password Credentials. Nesse cenário, além do Client ID e Client Secret, será necessário preencher os campos Username e Password com o usuário e senha do portal que possui os privilégios no módulo.
Limitações do Password Credentials: Ao utilizar essa opção, as credenciais M2M convencionais não se aplicam. É necessário utilizar credenciais disponibilizadas exclusivamente pelo time de produto TOTVS, e essas credenciais não são disponibilizadas a todos os produtos da Suíte Logística. 
Suporte: Caso não possua as credenciais necessárias para o tipo Password, abra um ticket no Suporte TOTVS indicando qual produto deseja integrar para que o caso seja avaliado.

Saiba mais
APIs do TOTVS Logística Coleta Entrega: Logística - TOTVS Coleta Entrega - Coleta Entrega - API REST 

Glossário
API: Application Programming Interface (Interface de Programação de Aplicação).
M2M: Machine-to-Machine (Integração Máquina para Máquina).
OAuth2: Protocolo de autorização padrão de mercado.