v1
latestOpenAPI 3.0.12026-07-261451591021.8 KBObtenção do grant code
Autenticação - Obtenção do grant code<br/>É um método crucial para autorizar o acesso seguro a APIs protegidas. Ela permite que aplicativos de terceiros solicitem acesso aos recursos de um usuário sem a necessidade de expor suas credenciais de login.<br/><br/>Funcionamento:<br/>- Troca do Código por Token de Acesso: O aplicativo cliente utiliza o código de concessão para solicitar um token de acesso ao servidor de autenticação. Esse token representa a autorização concedida pelo usuário e permite que o aplicativo acesse os recursos protegidos em seu nome.<br/>- Acesso aos Recursos Protegidos: O aplicativo cliente inclui o token de acesso em suas requisições para as APIs protegidas, validando sua autorização e permitindo o acesso aos recursos do usuário. <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>client_id</td><td>Texto</td><td>Identificador do Cliente</td><td>Sim</td></tr><tr><td>redirect_uri</td><td>Texto</td><td>URL de confirmação do comércio para indicar que o pagamento está em estado final.</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 grant-code</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>
Request body
Example request
{
"client_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"redirect_uri": "http://localhost/"
}Response
Grant Code obtido com sucesso
Example response
{
"message": "Grant-code gerado com sucesso.",
"data": {
"code": "abcd26efghi12823jklmnopqrst2y072v086w7x5"
},
"statusCode": 200,
"status": true
}