Autenticação
Saiba como obter autorização para acessar APIs Creditas
Disponibilizamos uma lista de APIs de acordo com nossos produtos e todas elas são de uso privado para parceiros Creditas e, portanto, é necessário que você forneça um access_token
em cada requisição para utilizar nossos recursos.
Para gerar JWT (access_token
) você irá precisar de um par de credenciais enviados pela Creditas, são elas:
- A
consumer_key
- A
consumer_secret
Eles funcionam como um par de ID e senha e devem ser solicitados através do link https://www.creditas.com/parceiros.
Você receberá as credenciais de acesso para ambos os ambientes (staging e production), com essas credenciais será possível obter o token para permite o uso das APIs.
Como obter o access_token
Agora é hora de utilizar as credenciais consumer_key
e consumer_secret
para obter o access_token
, ele será necessário para informar no cabeçalho de autenticação das outras requisições que utilizará.
Para obter seu access_token é necessário realizar uma requisição de acordo com a url do ambiente staging/production e consultar no response as informações necessárias a serem utilizadas nas demais requisições ( access_token
e expires_in
)
Credenciais por ambiente
O
access_token
deve ser gerado de acordo com o ambiente que será utilizado e para isso é necessário o uso das credenciaisconsumer_key
econsumer_secret
correspondentes.
Requisição HTTP POST
Ambiente | Tipo da Requisição | URL |
---|---|---|
Staging | POST | https://auth-staging.creditas.com.br/api/affiliate_clients/tokens |
Production | POST | https://auth.creditas.com.br/api/affiliate_clients/tokens |
Request Headers
Header | Valor |
---|---|
Accept-Version | v1 |
Content-Type | application/json |
Request Body
Campo | Tipo | Descrição |
---|---|---|
consumer_key | string | Sua consumer_key |
consumer_secret | string | Sua consumer_secret |
Request Response
Campo | Tipo | Descrição |
---|---|---|
access_token | string | Token de acesso aos recursos |
token_type | string | Tipo do token bearer |
refresh_token | string | Token utilizado para gerar um novo token |
expires_in | number | Tempo de expiração do token |
Exemplo de Request e Response
curl --location --request POST '{{url_ambiente}}' \
--header 'Accept-Version: v1' \
--header 'Content-Type: application/json' \
--data-raw '{
"consumer_key": "{{consumer_key}}",
"consumer_secret": "{{consumer_secret}}"
}'
{
"access_token": "1234SFDSF42423dfvxc",
"token_type": "bearer",
"refresh_token": "refresh-token",
"expires_in": 7200
}
Validade e expiração do access_token
Cada access_token gerado tem um tempo de expiração em segundos, essa validade pode ser obtida juntamente com a requisição do token no campo expires_in
. Após a expiração do token, todas as requisições passarão a retornar status_code 401 (Unauthorized)
, até que um novo token seja gerado.
Como utilizar o access_token
nas requisições
access_token
nas requisiçõesO uso do access_token
é obrigatório em todas as requisições, somente com ele é possível acessar os recursos disponíveis e, para isso é necessário o envio no cabeçalho (header) de cada requisição, veja abaixo como deve ser enviado:
Request Headers
Header | Valor |
---|---|
Accept | application/vnd.creditas.v1+json |
Content-Type | application/json;charset=UTF-8 |
Authorization | Bearer {{access_token}} |
Exemplo de Request
curl --location --request POST '{{endpoint}}' \
--header 'Accept: application/vnd.creditas.v1+json' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer {{access_token}}' \
Possíveis Erros
Consulte os possíveis retornos de erros, clique aqui
Bom trabalho! Agora você deve ser capaz de autenticar e usar APIs.
Updated 3 months ago