Download do certificado TLS

Este endpoint possibilita baixar o certificado TLS emitido pelo Bankly.

O certificado TLS será gerenciado pela private CA (Certificate Authority) do Bankly e possui um tempo de vida de até 365 dias.

🚧

Importante

O parceiro terá acesso à emissão e download de, no máximo, dois certificados.

Pré-requisito

Para que seja possível utilizar este endpoint, é necessário que:

• O legacy_access_token tenha sido gerado previamente.

📘

Nota

O legacy_access_token deve ser gerado com o scope certificate.create.

Requisição (Request)

Requisição HTTP

POST https://api.sandbox.bankly.com.br/partners/{{companyKey}}/certificates

--request POST \ 
--url 'https://api.sandbox.bankly.com.br/partners/{companyKey}/certificates' \
--header 'api-version: 1' \
--header 'Authorization: Bearer {legacy_access_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "passphrase": "{strong_passphrase}",
    "ttlInDays": 365
}'

Cabeçalhos (Headers)

Parâmetros da rota (Path)

No path desta requisição envie o seguinte campo:

👍

Dica

Caso você não conheça sua companyKey, entre em contato com o time de Implantação.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

{
    "passphrase": "{{strong_passphrase}}",
    "ttlInDays": 365
}

Resposta (Response)

O status code 200 indicará que o certificado mTLS foi baixado com sucesso.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

{
  "subjectDn": "serialNumber = {{ cnpj }}, businessCategory = {{ OPEN_API | FULL_BANK }}, UID = {{ Partner_UUID }}, C = BR, O = {{ Razão Social }}, ST = {{ state }}, L = {{ city }}, OU = {{ company_key }}, CN = {{ service_domain_name }}",
  "certificate": "-----BEGIN CERTIFICATE-----\nMIIGJzC...FlxkTQ8uA==\n-----END CERTIFICATE-----",
  "certificateChain": "-----BEGIN CERTIFICATE-----\nMIIEtz...2mRVNRYKb\n-----END CERTIFICATE-----",
  "privateKey": "-----BEGIN ENCRYPTED PRIVATE KEY-----\nMIIJQwI...8AfD+dQjc=\n-----END PRIVATE KEY-----\n",
  "passphrase": "cX@123aacx@123aacx@123aacx@123aacx@123aacx@123aacx@123aacx@123aa",
  "uuid": "UUID v4",
  "issuedAt": "2022-03-16T13:28:11.229549Z",
  "status": "ACTIVE",
  "createdAt": "2022-03-16T13:28:13.3213872Z", 
  "updatedAt": "2022-03-16T13:28:13.3213873Z" 
}

👍

Dica

Para simular uma requisição nesse endpoint, acesse o API Reference.

Por se tratar de dados altamente sensíveis, nós disponibilizaremos somente dois certificados para cada parceiro, sendo fundamental que eles sejam armazenados em local seguro, como um key vault (cofre de chaves), por exemplo.

❗️

Atenção

A chave privada (privateKey) atrelada ao certificado retornado só fica disponível uma única vez. Ou seja, em caso de nova requisição, esse campo não será retornado.

É preciso inserir o certificado, a privateKey e o passphrase em todas as requisições após o processo de emissão do certificado.

Se você estiver utilizando o Postman ou o Insomnia, poderá consultar os seguintes materiais que ajudarão nesse processo:

• Postman: working with certificates;
• Insomnia: client certificates.

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.