Cross Segmentos - Backoffice RM - Integração - API - Como são utilizados as Autenticações Basic e Bearer Token

Tempo aproximado para leitura: 00:03:00 min

Dúvida
Como configurar e utilizar as Autenticações Basic e Bearer Token no Postman?

Ambiente
Cross Segmentos - Backoffice RM - Integração - Todas as Versões

Solução
Nos passos sequenciais abaixo, constam exemplos de como autenticar através da ferramenta Postman.

01. Realizando autenticação Basic no Postman:

Exemplo de utilização falha ao utilizar Autenticação Basic, Perceba que o código HTTP 401 (Unauthorized) foi apresentado.
Falha na autenticação do Usuário "teste":

Importante
Aqui é necessário realizar algumas configurações conforme passos abaixo:

Para gerar um token assinado por um certificado do cliente, é necessário:

• Um certificado válido.
• Acrescentar no arquivo de configuração do Host (RM.Host.exe.config | RM.Host.Service.exe.config) as seguintes TAG's:
  JWTCERTIFICATETHUMBPRINT (Obrigatório)
  JWTISSUERNAME (Opcional)
  JWTAUDIENCE (Opcional)
  JWTCERTIFICATETHUMBPRINT => Thumbprint do certificado.
  JWTISSUERNAME => O nome da API que gerou o Token.
  JWTAUDIENCE => Destinatário do Token, representa a aplicação que irá usá-lo

Para gerar um token sem assinatura pelo Host, não é obrigatório adicionar as TAG's no arquivo de configuração.

02. Utilizando Autenticação Bearer Token, realize uma requisição HTTP ao endpoint http(s)://{dominio}:{ApiPort}/api/connect/token/ via Postman, SoapUi, ou outro programa que realize requisições HTTP rest.

Na requisição deve-se utilizar o método POST e no corpo da requisição deve-se utilizar o JSON com os campos e valores "username" e "password":

{
"username": "mestre",
"password": "totvs"
}

O token de segurança será gerado e já poderá ser utilizado no cabeçalho das requisições subsequentes às API's disponibilizadas pela TOTVS.

Utilize o token gerado incluindo-o no cabeçalho da requisição através do tipo de autenticação: Bearer Token, conforme no PRINT abaixo da ferramenta Postman:

Após a inclusão do cabeçalho de autorização, realize uma requisição HTTP em uma das API's disponibilizadas pela TOTVS e verifique o resultado, conforme no PRINT abaixo da ferramenta Postman a requisição realizada na API de Usuário utilizando o token gerado:

Verifique que a requisição foi realizada com sucesso e os dados foram apresentados corretamente.
Exemplo de utilização falha ao utilizar Autenticação Bearer Token, falha na requisição. Token expirado:

Obs.: Caso seja apresentado o erro abaixo, verifique no Body da requisição no Postman, se foi utilizado o formato Text.

Para o correto funcionamento, é preciso utilizar o formato Json.

03. A tabela que guarda os tokens gerados:

SELECT * FROM GAPITOKENS