Como se autenticar na API

Para se autenticar na API, você precisa consumir o endpoint "/api/v1/login/auth", usando o "login" e "password" informados pelo suporte, além da URL da sua conta.

Uma vez autenticado, você receberá um "token" (uma chave) de autenticação.

Esse "token" será usado para consumir todos os demais endpoints da API.

É importante ressaltar que o "token" expira em tempos aleatórios. Por isso, a cada novo request que sua aplicação fizer na API, deverá salvar o retorno com o novo token (newToken) na memória/banco de dados de sua aplicação.

Assim, você garante que sua aplicação não seja desconectada e não precise fazer "auth" a cada request.

Vale lembrar que mesmo renovando o "token", ele terá 30 dias de validade. Portanto, mesmo com a reciclagem do "token", ele irá expirar. Então, prepare sua aplicação para ser capaz de fazer uma nova autenticação usando o endpoint "login/auth" caso a renovação de token seja impossível.

Ou seja, o processo será:

1. Obter o "token" usando o "POST /login/auth" (conexão inicial)
   
   
2. Salvar o "token" na memória/banco de dados da sua aplicação.
   
   
3. Consumir um endpoint da API.
   1. Recuperar o "newToken" no JSON do endpoint que você consumiu.
   2. Atualizar o "token" na memória/banco de a sua aplicação com o valor de "newToken"
   3. Repetir esse processo (passo 3) toda vez que consumir um endpoint, sempre substituindo o valor do "token" atual na sua memória pelo "newToken" retornado pela API.

1. Use o endpoint de autenticação

1.1 Substitua pela URL de sua conta, por exemplo:

POST https://suaconta.agoraos.com.br/api/v1/login/auth

1.2 No Postman, alterar as variaveis da coleção (pasta pai):

1. Selecionar a pasta pai "API V1 ou API V2"
   
   
2. Clicar em "Variables"
   
   
3. Alterar o valor das variaveis: "Current Value"
   1. QA: https://suaconta.agoraos.com.br
   2. Login (login da sua conta)
   3. Senha (senha da sua conta)
      
      * Recomendamos criar um usuário específico para a API sem permissões de sistema. Para testes, use o login de administrador.

2. Para logar, use o método POST /login/auth

1. POST /api/v1/login/auth
2. Pegar o valor de "token" salvar na sua aplicação.

Salve o "token" de autenticação (arr_dados.token).

Por exemplo: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXUyJ9.eyJjb250YSI6I..."

A partir de agora, todas as próximas conexões na API serão feitas utilizando o "token".

Esse token deverá ser salvo na memória do seu aplicativo, ou no banco de dados.

Atenção: o "token" muda a cada novo request na API. Lembre-se de salvar o "token-reciclado" na memória da sua aplicação.

3. Usando o "token" para consumir um endpoint

Por exemplo, se quisermos recuperar os dados do cliente 2.

Endpoint: GET https://suaconta.agoraos.com.br/api/v1/cliente/2

3.1 Modifique os "Headers" do request para ter o parâmetro "Authorization"

3.2 O parâmetro "Authorization" deve vir com o valor "Bearer TOKEN"

3.2.1 O "token" será substituido pelo "token" que você recuperou no "auth", sem espaços no final.

Não se esqueça da palavra "Bearer" com espaço antes de informar o TOKEN.

Substitua "suaconta" na URL pelo nome de sua conta conosco

3.2 Em caso de sucesso, atualize na sua aplicação o "newToken" gerado, substituindo o valor do "token" anterior gerado no "auth".

Esse processo de substituir o "token" pelo "newToken" deve ser feito a cada vez que você consumir a API.

O valor retornado em "newToken" deverá ser usado na próxima vez que você consumir qualquer endpoint da API.