Añadir archivos al sobre

URL base: https://business.digito.do/api/v2.

EjemplosCopiar link al encabezado

Configura DIGITO_API_TOKEN en el servidor. Sustituye los IDs y archivos de ejemplo por los de tu equipo. TypeScript usa fetch y FormData de Node.js.

curl --fail-with-body \
  --request POST \
  --url 'https://business.digito.do/api/v2/envelope/item/create-many' \
  --header "Authorization: $DIGITO_API_TOKEN" \
  --form 'payload={
  "envelopeId": "sobre_de_ejemplo"
}' \
  --form 'files=@./documento.pdf;type=application/pdf'

AutenticaciónCopiar link al encabezado

Envía el token de la API en el encabezado Authorization. El acceso corresponde al equipo y a los permisos del token. Conserva el token en tu servidor.

Authorization: api_TU_TOKEN

Antes de cada acción de firma, el firmante debe autenticarse de nuevo con Digito ID. Una sesión previa de Business, un token de destinatario o un token de la API no sustituye este requisito.

ParámetrosCopiar link al encabezado

Esta operación no declara parámetros de ruta ni de consulta.

Cuerpo de la solicitudCopiar link al encabezado

El cuerpo es obligatorio.

Tipo de contenido: multipart/form-data.

Objeto payloadCopiar link al encabezado

Envía este objeto como texto JSON en la parte payload del formulario.

{
  "envelopeId": "sobre_de_ejemplo"
}

Añade el PDF en una parte files. Para varios archivos, repite esa parte. Deja que el cliente HTTP construya el límite multipart; no fijes manualmente Content-Type.

Los valores muestran una solicitud posible; no son valores predeterminados del servidor.

Propiedades de payloadCopiar link al encabezado

{
  "type": "object",
  "properties": {
    "payload": {
      "type": "object",
      "properties": {
        "envelopeId": {
          "type": "string"
        }
      },
      "required": [
        "envelopeId"
      ]
    },
    "files": {
      "type": "array",
      "items": {}
    }
  },
  "required": [
    "payload"
  ]
}

Respuesta de éxitoCopiar link al encabezado

Este objeto sintético ilustra la estructura completa de una respuesta 200. Los identificadores, fechas, estados y tokens son datos de ejemplo.

{
  "data": [
    {
      "id": "archivo_de_ejemplo",
      "title": "Contrato de servicios",
      "envelopeId": "sobre_de_ejemplo",
      "order": 1,
      "documentDataId": "datos_del_documento_de_ejemplo"
    }
  ]
}

Respuestas y erroresCopiar link al encabezado

Los esquemas enlazados incluyen propiedades anidadas, campos obligatorios, variantes, enumeraciones, nulabilidad y restricciones. Consulta errores y reintentos para manejar respuestas no exitosas.

Identificador de operación: envelope-item-createMany.