Faça sua autenticação

Para obter acesso à API, você precisa ser um parceiro da Creditas. Solicite ao seu contato comercial que abra uma requisição junto ao time de tecnologia para a criação das credenciais.

Se você ainda não for um parceiro da Creditas, acesse o link https://www.creditas.com/parceiros para se cadastrar.

Após o cadastro, você receberá as informações necessárias para obter o token de acesso à nossa API. Disponibilizamos uma lista de APIs de acordo com nossos produtos, todas de uso exclusivo para parceiros Creditas. Portanto, é obrigatório fornecer 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 permitir 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 credenciais consumer_key e consumer_secret correspondentes.

Requisição HTTP POST

Request Headers

Request Body

Request Response

Fazendo sua requisição em staging

Request

curl --location --request POST '<https://auth-staging.creditas.com.br/api/affiliate_clients/tokens'>  
--header 'Accept-Version: v1'  
--header 'Content-Type: application/json'  
--data-raw '{  
    "consumer_key": "{{consumer_key}}",  
    "consumer_secret": "{{consumer_secret}}"  
}'

Response

{  
    "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.

Possíveis Erros

Consulte os possíveis retornos de erros, clique aqui

Bom trabalho! Agora você deve ser capaz de autenticar e usar APIs.