Sua Primeira Consulta
Use o access_token no header Authorization para fazer sua primeira chamada GET à API. Valide sua autenticação, consulte um endpoint real e veja a resposta de sucesso (200 OK).
Para validar o uso do access_token, obtido na última seção (Autenticação e Ambientes), iremos usar nosso endpoint de elegibilidade.
1. Como usar seu Access Token (O Header Authorization)
Authorization)Para** todas as requisições** (que não sejam a de gerar o token), você deve enviar seu access_token em um header HTTP chamado Authorization.
O formato deve ser Bearer, seguido de um espaço e do seu token.
2. Exemplo: endpoint de elegibilidade
Para nosso primeiro teste, faremos uma chamada GET segura ao endpoint /eligibility. Esta consulta verifica se um cliente (com base no cpf e email) é elegível para uma proposta.
Requisição HTTP GET
| Ambiente | Tipo de Requisição | URL | Endpoint |
|---|---|---|---|
| Staging | GET | https://stg-api.creditas.io/b2b | /borrowers/eligibility |
| Production | GET | https://api.creditas.io/b2b | /borrowers/eligibility |
2.1. Referências e Parâmetros
Request Header
| Header | Valor |
|---|---|
| Accept-Version | v1 |
| Content-Type | application/json |
| Authorization | Bearer your_access_token |
Request Parameters
Campo | Tipo | É obrigatório? | Descrição |
|---|---|---|---|
| string | Sim | CPF da proposta
|
| string | Sim | E-mail da proposta |
| string | Não | Nome do produto: |
2.2. Request e Response
curl --location --request GET 'https://stg-api.creditas.io/b2b/borrowers/eligibility?cpf=12345678909&[email protected]' \
--header 'Accept: application/vnd.creditas.v1+json' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer {{your_access_token}}'[
{
"product": "AUTO_REFINANCING",
"eligible": true
},
{
"product": "HOME_REFINANCING",
"eligible": true
}
]Se sua chamada for bem-sucedida, você receberá um status 200 OK e um JSON informando se a elegibilidade é "true"(cliente elegível) ou "false" (cliente inelegível).
- Essa chamada de elegibilidade faz a verificação se o cliente está elegível à criação de uma proposta.
2.1. Erros Comuns
401 Unauthorized (Token Inválido) Se você receber este erro, 99% das vezes é porque seu access_tokenexpirou ou está mal formatado.
- Como corrigir: Volte à seção Autenticação e Ambientes e gere um novo access_token.
Updated about 14 hours ago