v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB
Autenticação

Obtenção do Access Token

Autenticação- Obtenção do Acess Token<br/><br/>É uma string criptografada que representa a autorização concedida pelo usuário e permite que o aplicativo acesse os recursos protegidos em seu nome. Ele contém informações como:<br/>- Identificador do Usuário: Identifica o usuário que concedeu o acesso.<br/>- Identificador do Aplicativo Cliente: Identifica o aplicativo que está solicitando o acesso.<br/>- Escopos de Acesso: Define quais recursos específicos o aplicativo pode acessar.<br/>- Data de Expiração: Indica quando o token se torna inválido e precisa ser atualizado.<br/><br/>A API de Autenticação - Obtenção do Token de Acesso é um componente essencial do OAuth, fornecendo um mecanismo seguro e padronizado para autorizar o acesso a APIs protegidas. Sua implementação adequada garante uma experiência de usuário segura e confiável, além de proteger dados confidenciais.<br/><br/>Para realizar a autenticação de forma correta e segura, deve-se ser codificado em base64 a junção do cliente_id e client_secret do usuário, separado por um sinal de mais (+). Essa codificação sera usada no Header Authorization -> Basic token<br/><br/>Exemplo de utilização do base64 encode<br/>var encodeCredentials = base64_encode(client_id.'+'.client_secret);<br/><br/>Header -> Authorization -> Basic $encodeCredentials<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>code</td><td>Texto</td><td>Código de autorização do token.</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 acessar o token</td></tr><tr><td>data</td><td>Texto</td><td>Retorna os valores do access_token, refresh_token e tempo de expiração do refresh_token. O expires_in refere-se ao tempo de experição do refresh_token.</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/access-token

Headers

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

Client ID enviado no Header

Request body

grant_typestring required
codestring required

Example request

{
  "grant_type": "authorization_code",
  "code": "code"
}

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
}