Autenticação - Login
Neste endpoint será possível que os parceiros realizem a autenticação para obtenção do Access Token que deverá ser enviado nas demais consultas.
O serviço irá verificar se o usuário e senha fornecidos durante a requisição correspondem aos mesmos cadastrados na tabela de usuário da nossa API, e caso não correspondam, o serviço irá gerar uma exceção de falha de segurança.
POST
/auth/reconciliation/token
HEADERS
Content-Type* string/fixo
application/json
BODY (RAW)
email* string
E-mail de login
password* string
Senha de acesso
grant_type* string/fixo
"password"
EXEMPLO
{
"email": "<[email protected]>",
"password": "<password_parceiro>",
"grant_type": "password"
}
RETORNOS
Abaixo estão os possíveis códigos de retorno e o descritivo de cada um:
200 - OK
Significa que sua requisição foi bem-sucedida e o “Access Token” será retornado no corpo da resposta.
400 - Credentials is required
O sistema não conseguiu encontrar suas credenciais para efetuar o login.
401 - Invalid access token
Credenciais não estão sendo enviadas, estão de forma incorreta, usuário não possui permissão de acesso, senha/login inválido.
500 - Request token error
Faltou informar algum parâmetro na requisição.
br>
RETORNO SUCESSO
Caso ocorra tudo certo com sua requisição a mesma irá retornar uma mensagem de sucesso, conforme exemplo abaixo:
{
"access_token": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"token_type": "bearer",
"refresh_token": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"expires_in": 9999,
"scope": "reconciliation",
"user_detail": {
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"name": "Squad Conciliação",
"email": "[email protected]",
"metadata": [
{
"id": {
"userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"key": "documentNumber"
},
"value": "paygo",
"schema": "STRING_ARRAY"
},
{
"id": {
"userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"key": "whitelabel"
},
"value": "paygo",
"schema": "STRING_ARRAY"
}
],
"roles": [
"RECONCILIATION_CONCILIATOR"
]
}
}
DETALHE DOS CAMPOS
Abaixo está a descrição dos campos recebidos como resposta:
Campo | Tipo | Descrição |
---|---|---|
access_token | Alfanumérico | Access Token que deverá ser utilizado nas demais requisições |
token_type | Alfanumérico | Tipo do Token (bearer) |
refresh_token | Alfanumérico | Token de atualização |
expires_in | Numérico | Tempo de expiração do Access Token |
scope | Alfanumérico | Escopo de acesso |
user_detail | Alfanumérico | Detalhes do usuário passado na request |
id | Alfanumérico | ID do usuário na nossa API |
name | Alfanumérico | Nome do usuário |
Alfanumérico | E-mail do usuário | |
metadata | Container | Lista de metadados do usuário |
id | Alfanumérico | ID do usuário na nossa API |
key | Alfanumérico | Tag para identificação do usuário |
value | Alfanumérico | Valor de qualificação do usuário |
schema | Alfanumérico | Formato do metadado |
roles | Container | Lista das permissões que o usuário possui nas nossas APIs |
Updated almost 3 years ago