Enviar certificado digital A1

Parâmetros, estrutura de dados e respostas do contrato versionado.

POST/fiscal/certificado

uploadFiscalCertificateBase de Homologação: https://api.fleetpay.site/v1

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

Envia ou substitui o certificado digital da transportadora.

Autenticação

[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]

A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

Nenhum parâmetro declarado nesta operação.

Corpo da Requisição

Obrigatório

`multipart/form-data`

filestring · binaryObrigatório

Certificado A1 em .pfx ou .p12, com no máximo 10 MB.

cert_passstring · passwordObrigatório

Senha do certificado; nunca é devolvida pela API.

Respostas

201 Resposta HTTP

Certificado digital enviado e metadados atualizados.

`application/json`

CertificateEnvelope ↗

dataobjectObrigatório

CertificateMetadata ↗

environmentobjectObrigatório

Environment ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

401 Resposta HTTP

Chave de API FleetPay ausente ou inválida.

`application/json`

ErrorEnvelope ↗

errorobjectObrigatório

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

403 Resposta HTTP

Escopo fiscal desabilitado na chave, ou chave sem transportadora ativa.

`application/json`

ErrorEnvelope ↗

errorobjectObrigatório

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

422 Resposta HTTP

Payload inválido.

`application/json`

ErrorEnvelope ↗

errorobjectObrigatório

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

429 Resposta HTTP

Limite por transportadora excedido.

`application/json`

ErrorEnvelope ↗

errorobjectObrigatório

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

Retry-After

Segundos até uma nova tentativa.

500 Resposta HTTP

Falha interna sem detalhes de integrações operacionais.

`application/json`

ErrorEnvelope ↗

errorobjectObrigatório

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

Definição Completa da Operação

{
  "tags": [
    "Configuração"
  ],
  "summary": "Enviar certificado digital A1",
  "description": "Envia ou substitui o certificado digital da transportadora.",
  "operationId": "uploadFiscalCertificate",
  "requestBody": {
    "required": true,
    "content": {
      "multipart/form-data": {
        "schema": {
          "type": "object",
          "required": [
            "file",
            "cert_pass"
          ],
          "properties": {
            "file": {
              "type": "string",
              "format": "binary",
              "description": "Certificado A1 em .pfx ou .p12, com no máximo 10 MB."
            },
            "cert_pass": {
              "type": "string",
              "format": "password",
              "description": "Senha do certificado; nunca é devolvida pela API."
            }
          }
        },
        "encoding": {
          "file": {
            "contentType": "application/x-pkcs12, application/octet-stream"
          }
        }
      }
    }
  },
  "responses": {
    "201": {
      "$ref": "#/components/responses/CertificateCreated"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "403": {
      "$ref": "#/components/responses/Forbidden"
    },
    "422": {
      "$ref": "#/components/responses/ValidationFailed"
    },
    "429": {
      "$ref": "#/components/responses/RateLimited"
    },
    "500": {
      "$ref": "#/components/responses/InternalError"
    }
  },
  "method": "POST",
  "path": "/fiscal/certificado",
  "parameters": []
}