POST | Baixar o certificado

  • 1 minuto(s) lido(s)
Prev Next

Baixa o certificado digital em diversos formatos. A API suporta diferentes tipos de exportação e fornece opções para gerenciar chaves privadas e criptografias.

  • Endpoint: /api/certificate/download
  • Método: POST
  • Requisição: POST /api/certificate/download

Parâmetros da requisição

Parâmetro Tipo Obrigatório Descrição
id Int Sim ID utilizado para localizar e recuperar o certificado.
format String Sim Formato do arquivo para o certificado. Valores suportados: pfx, pem, e crt.
download_key String Não Se true, inclui a chave privada no download. Aplica somente para os formatos pem e crt. Para o formato pfx, a chave sempre será incluída e esse parâmetro será ignorado.
password String Condicional Senha para criptografar o arquivo. Obrigatório para o formato pfx. Para os formatos pem e crt, é obrigatório somente caso o parâmetro download_key for true.

Formato das respostas

Resposta do formato PFX

{
  "format": "pfx",
  "certificate": "MIID6TCCAtGgAwIBAgIBADA..."
}

Resposta do formato PEM

{
  "format": "pem",
  "certificate": "MIID6TCCAtGgAwIBAgIBADA..."
}

Resposta do formato CRT

Quando o parâmetro download_key é false (padrão):

{
  "format": "crt",
  "certificate": "MIID6TCCAtGgAwIBAgIBADA..."
}

Quando download_key é true:

{
  "format": "crt",
  "certificate": "MIID6TCCAtGgAwIBAgIBADA...",
  "key": "MIID6TCCAtGgAwIBAgIBADA...",
  "key_format": "key"
}

Exemplos de requisições

Download básico do certificado (Formato PFX)

curl -X POST https://[segura_vault_url]/api/certificate/download \
  -H "Content-Type: application/json" \
  -d '{
    "id": "12345",
    "format": "pfx",
    "password": "securepassword123"
  }'

Certificado com uma chave privada (Formato CRT)

curl -X POST https://[segura_vault_url]/api/certificate/download \
  -H "Content-Type: application/json" \
  -d '{
    "id": "12345",
    "format": "crt",
    "download_key": true,
    "password": "keyprotectionpassword"
  }'

Considerações de segurança

  1. Sempre transmita solicitações via HTTPS para proteger dados sensíveis de certificados e senhas.
  2. Use senhas fortes ao criptografar chaves privadas ou arquivos PFX.
  3. Implemente controle de acesso adequado para garantir que apenas usuários autorizados possam baixar certificados.

Respostas de erro

Status HTTP Descrição
400 Bad Request Parâmetros inválidos fornecidos (campos obrigatórios ausentes ou formato inválido).
404 Not Found Certificado com o ID especificado não foi encontrado.
403 Forbidden Permissões insuficientes para baixar o certificado solicitado.
500 Internal Server Error Erro do lado do servidor ocorreu durante o processamento do certificado.

Observações

  • Os dados do certificado e chave na resposta estão codificados em Base64.
  • Quando download_key é definido como true e uma senha é fornecida, a chave privada será criptografada usando a senha fornecida.
  • O formato PFX sempre inclui tanto o certificado quanto a chave privada em um único arquivo.