Enviar un certificado digital A1

Parámetros, estructura de datos y respuestas del contrato versionado.

POST/fiscal/certificado

uploadFiscalCertificateBase de Pruebas: https://api.fleetpay.site/v1

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

Envía o sustituye el certificado digital del transportista.

Autenticación

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

La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.

Parámetros

No hay parámetros declarados para esta operación.

Cuerpo de la Solicitud

Obligatorio

`multipart/form-data`

filestring · binaryObligatorio

Certificado A1 en formato .pfx o .p12, de hasta 10 MB.

cert_passstring · passwordObligatorio

Contraseña del certificado; la API nunca la devuelve.

Respuestas

201 Respuesta HTTP

Certificado digital enviado y metadatos actualizados.

`application/json`

CertificateEnvelope ↗

dataobjectObligatorio

CertificateMetadata ↗

environmentobjectObligatorio

Environment ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

401 Respuesta HTTP

Clave de API FleetPay ausente o no válida.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

403 Respuesta HTTP

Ámbito fiscal deshabilitado en la clave, o clave sin transportista activo.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

422 Respuesta HTTP

Payload inválido.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

429 Respuesta HTTP

Límite por transportista excedido.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

Retry-After

Segundos hasta un nuevo intento.

500 Respuesta HTTP

Fallo interno sin detalles de las integraciones operativas.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

Definición Completa de la Operación

{
  "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": []
}