Quando utilizado OAuth
Antes de iniciar o processo de autenticação, cheque se você já possui:
- Uma conta do GTI PLUG.
- Uma url de callback para receber a primeira credencial da conta.
- Credenciais client_id e client_secret.
O que é uma URL de callback?
Num fluxo de autenticação, o seu aplicativo solicita autorização para ter acesso a uma conta dentro da estrutura do GTI PLUG. Por isso, precisamos de um "endereço de entrega" do seu aplicativo para podermos devolver essa autorização, caso nosso cliente autorize a conexão da sua aplicação com o GTI PLUG. Esse endereço de entrega é a url de callback.
Uma url de callback se parece com isso: https://suaurl/auth/callback
O que são Credenciais?
No fluxo OAuth de autenticação, seu aplicativo possui duas credenciais, que chamamos de client_id e client_secret. Essas credenciais são utilizadas para gerar tokens de acesso.
Uma vez que um token de acesso tenha sido gerado, ele será utilizado nas trocas de mensagens via API.
Se você ainda não possui essas credenciais, poderá gerá-las acessando o GACE. É lá que você irá fazer o processo de submissão do seu aplicativo, e após isso suas credenciais serão criadas.
Caso você já possua as credenciais, poderá iniciar o processo de autenticação agora mesmo.
Como obter um refresh token?
Basicamente, um refresh token possui as informações necessárias para que possamos gerar um novo access token. O refresh_token é obtido junto com a chamada para geração do token.
Como utilizar um refresh token?
Agora que já obtemos o refresh token, precisamos utilizá-lo para renovar nosso access token. Para isso basta fazermos uma requisição POST à token URL com uma simples diferença: no parâmetro grant type, colocaremos “grant_type=refresh_token”.
Importante: Somente faça requisições para obter um novo access token quando o token expirar. Nossas APIs possuem “rate limits” que funcionam como um limite de requisições permitidas por minuto. Fazer uma requisição de um novo access token sempre que for utilizar um recurso qualquer da API que exija o access token é uma péssima prática.