Nesse endpoint é possível realizar uma autenticação utilizando um certificado mTLS para realizar o consumo das APIs de Crédito.
Nesse endpoint é possível realizar uma autenticação utilizando um certificado mTLS para realizar o consumo das APIs de Crédito.
A API de Crédito utiliza o protocolo OAuth 2.0, com o fluxo client_credentials + certificado mTLS, para obtenção do token de acesso.
Após a habilitação das credenciais e a configuração dos requisitos de segurança, o cliente poderá realizar a requisição de autenticação.
URLs Base para Autenticação com token V5:
- SANDBOX: https://sandbox-apicorp.celcoin.com.br/v5/token
- PRODUÇÃO: https://apicorp.celcoin.com.br/v5/token
Parâmetros da requisição
| Parâmetro | Local | Descrição |
|---|---|---|
client_id | Authorization | Identificador da credencial de autenticação fornecida pela Celcoin. |
client_secret | Authorization | Chave secreta associada ao client_id. |
grant_type | Body | Deve ser informado com o valor client_credentials. |
Content-Type | Header | Deve ser informado como application/x-www-form-urlencoded. |
cert | Authorization | Base64 do arquivo do certificado |
key | Authorization | Base64 do arquivo contendo a chave privada |
As credenciais client_id e client_secret são utilizadas no header HTTP Authorization, com o prefixo Basic, conforme o padrão de autenticação OAuth 2.0 documentado pela Celcoin.
O valor enviado deve corresponder à codificação Base64 da combinação client_id:client_secret.
Exemplo de requisição
O exemplo abaixo demonstra a estrutura da solicitação de token com autenticação Basic e certificado de cliente. Os endereços e arquivos devem ser substituídos pelos dados homologados para sua integração.
curl --request POST \
--url '<URL_DE_AUTENTICACAO_V5>' \
--cert '<CAMINHO_CERTIFICADO_CLIENTE>' \
--key '<CAMINHO_CHAVE_PRIVADA>' \
--header 'accept: application/json' \
--header 'content-type: application/x-www-form-urlencoded' \
--user '<CLIENT_ID>:<CLIENT_SECRET>' \
--data-urlencode 'grant_type=client_credentials'Observações:
- O exemplo utiliza arquivos separados para o certificado e a chave privada.
- A configuração do certificado pode variar conforme o formato disponibilizado e a tecnologia utilizada pelo cliente.
- O endereço do servidor de autenticação deve corresponder ao ambiente e ao modelo de autenticação habilitados pela Celcoin.
- Os arquivos de certificado e chave privada não devem ser compartilhados publicamente.
Utilização do token nas APIs de Crédito
Após a autenticação bem-sucedida, o servidor retorna um token de acesso que deverá ser utilizado nas requisições subsequentes.
O token deve ser informado no header HTTP Authorization, precedido pelo prefixo Bearer.
Exemplo
Authorization: Bearer <ACCESS_TOKEN>O token permite que a aplicação realize requisições autenticadas às APIs de Crédito, respeitando as permissões associadas às credenciais utilizadas.
Validade do token
Conforme a documentação de autenticação da Plataforma de Crédito, o token possui validade de 3.600 segundos (60 minutos).
Não é necessário solicitar um novo token a cada requisição. A aplicação deve controlar a validade do token e solicitar um novo quando necessário.