Faça sua primeira consulta

Siga nosso passo a passo para realizar a sua primeira consulta em nossa API.

Introdução

🚧

Atenção!

Antes de iniciar a integração, é necessário estar com suas chaves de API.

Como se autenticar?

1. Para se autenticar, será necessário obter um access token do tipo OAuth 2.0.

Utilizaremos a seguir sua credencial de Sandbox, a qual você já deve estar de posse neste ponto.

Atributos

Descrição

client_id

Seu identificador único na Celcoin

grant_type

Tipo de acesso

client_secret

Sua chave de acesso

2. Acesse a documentação do endpoint /token.

Formulário do endpoint token.Formulário do endpoint token.

Formulário do endpoint token.

3. Preencha os campos do formulário utilizando as informações disponibilizadas pelo time de suporte e clique em "Try it!".

4. Se tudo estiver configurado corretamente, você receberá uma resposta HTTP Status 200, com o token de acesso.

Exemplo de resposta 200 com o token de acesso.Exemplo de resposta 200 com o token de acesso.

Exemplo de resposta 200 com o token de acesso.

5. Pronto! Você está autenticado.

Como consultar alguma informação?

1. Como exemplo, acesse a documentação do endpoint /banks.

2. Clique em "Authentification", insira a palavra "Bearer", dê um espaço, coloque o acess_token gerado na API de autenticação e clique em "Try it!".

3. Se tudo ocorrer como esperado, você receberá uma resposta HTTP Status 200, com a lista de bancos.

Exemplo de resposta 200 com a lista de alguns bancos retornados pelo endpoint /banks.Exemplo de resposta 200 com a lista de alguns bancos retornados pelo endpoint /banks.

Exemplo de resposta 200 com a lista de alguns bancos retornados pelo endpoint /banks.

Parabéns, você fez sua primeira consulta em nossa API!

Caso queira realizar o teste dessa requisição no Postman, deixamos abaixo um modelo de cURL.

curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/v5/transactions/banks' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access_token}'

What’s Next

Próximos passos

Did this page help you?