v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB
Autenticação

Obtenção do Refresh Access Token

Autenticação- Obtenção do Refesh Acces Token<br/>É uma string criptografada com vida útil mais longa que o token de acesso. Ele permite que o aplicativo obtenha um novo par de tokens de acesso e atualização sem precisar solicitar novamente a autorização do usuário.<br/><br/>Funcionamento do Token de Atualização:<br/>- Token de Acesso Expirado: Quando o token de acesso expira, o aplicativo tenta acessar uma API protegida e recebe uma resposta de erro.<br/>- Solicitação de Novo Token de Acesso: O aplicativo utiliza o token de atualização para solicitar um novo par de tokens de acesso e atualização ao servidor de autenticação.<br/>- Emissão de Novos Tokens: Se o token de atualização for válido, o servidor emite um novo par de tokens de acesso e atualização com validades atualizadas.<br/>- Acesso Contínuo: O aplicativo utiliza o novo token de acesso para continuar acessando as APIs protegidas.<br/><br/>Requisição<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th><th>Obrigatoriedade</th></tr></thead><tbody><tr><td>grant_type</td><td>Texto</td><td>Identificador do tipo de autorização solicitada.</td><td>Sim</td></tr><tr><td>refresh_token</td><td>Texto</td><td>Refresh token gerado.</td><td>Sim</td></tr></tbody></table><br/><br/>Resposta<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>message</td><td>Texto</td><td>Mensagem de sucesso ao gerar o token</td></tr><tr><td>Data - Access_token</td><td>Texto</td><td>Access Token gerado</td></tr><tr><td>Data - Refresh_token</td><td>Texto</td><td>Refresh Token gerado</td></tr><tr><td>Data - Expires-in</td><td>Número</td><td>Data de expiração do novo access token gerado</td></tr><tr><td>statusCode</td><td>Número</td><td>Código de retorno da requisição</td></tr><tr><td>status</td><td>Booleano</td><td>Um status de verdadeiro ou falso que representa se a requisição retornou um sucesso ou não</td></tr></tbody></table>

post/api/oauth/refresh-token

Headers

client-idstring uuid required
Example:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Client ID enviado no Header

Request body

grant_typestring required
refresh_tokenstring required

Example request

{
  "grant_type": "refresh_token",
  "refresh_token": "token"
}

Response

Access Token obtido com sucesso

messagestring
statusCodeinteger
statusboolean

Example response

{
  "message": "Access Token gerado com sucesso.",
  "data": {
    "access_token": "token",
    "refresh_token": "token",
    "expires_in": 7200
  },
  "statusCode": 200,
  "status": true
}