Distribuir, seguir y descargar
Distribuye un borrador revisado, confirma su estado y descarga todos los PDFs finales con cURL o TypeScript.
Convierte un borrador revisado en un proceso de firma y archiva el resultado al completarse. Necesitas el id devuelto al crear un documento o usar una plantilla.
Revisa antes de distribuir
La distribución puede iniciar comunicaciones a destinatarios. Confirma los correos, las versiones de los PDFs y los campos antes de ejecutar este paso. Utiliza datos sintéticos en las pruebas.
Confirma el borrador y distribuye
Consulta el sobre para confirmar status: "DRAFT". Sustituye envelope_ejemplo por el ID de tu documento. La configuración de meta de este ejemplo usa mensajes en español.
# Primero revisa el detalle y los archivos en Business.
curl --fail-with-body \
'https://business.digito.do/api/v2/envelope/envelope_ejemplo' \
-H "Authorization: $DIGITO_API_TOKEN"
# Ejecuta la distribución únicamente después de la revisión.
curl --fail-with-body \
'https://business.digito.do/api/v2/envelope/distribute' \
-H "Authorization: $DIGITO_API_TOKEN" \
-H 'Content-Type: application/json' \
--data '{
"envelopeId": "envelope_ejemplo",
"meta": {
"language": "es",
"subject": "Revisión y firma de contrato",
"message": "Por favor, revisa el documento antes de firmar."
}
}'La respuesta incluye success, id y recipients. success: true confirma la distribución; no confirma que el proceso esté firmado. Los destinatarios contienen datos privados, tokens y signingUrl: no registres el objeto completo.
Si se agota la espera, consulta el estado antes de repetir. /envelope/redistribute vuelve a notificar a destinatarios determinados; no lo conviertas en un reintento automático de distribución.
Sigue el proceso desde el servidor
Obtén el detalle periódicamente. En TypeScript, esta consulta espera hasta un plazo definido por tu aplicación; no realiza acciones de firma.
curl --fail-with-body \
'https://business.digito.do/api/v2/envelope/envelope_ejemplo' \
-H "Authorization: $DIGITO_API_TOKEN"Los intervalos son decisiones del ejemplo, no plazos del servicio. Una firma puede llegar más tarde; conserva el ID y reanuda el seguimiento según tu proceso. En producción, añade reintentos de lectura y consulta desde un trabajo de servidor, no desde cada renderizado del frontend.
| Estado | Acción de la integración |
|---|---|
DRAFT | Revisa si la distribución llegó a aplicarse. |
PENDING | Conserva el proceso abierto y consulta más tarde. |
COMPLETED | Comprueba y descarga los PDFs finales. |
REJECTED | Revisa el destinatario y su rejectionReason. |
CANCELLED | Cierra el seguimiento y presenta el estado correcto. |
Un correo enviado, una apertura, una redirección o un callback del navegador no equivalen a COMPLETED. El firmante se autentica de nuevo con Digito ID antes de cada acción de firma; una sesión o un token técnico no sustituye esa autenticación.
Descarga cada PDF final
Cuando el sobre esté completado, toma los IDs de envelopeItems. La descarga utiliza el ID del elemento, no el del sobre, y version=signed.
# Tras comprobar COMPLETED, usa un ID real de envelopeItems.
curl --fail-with-body \
'https://business.digito.do/api/v2/envelope/item/item_ejemplo/download?version=signed' \
-H "Authorization: $DIGITO_API_TOKEN" \
--output './documento-firmado-1.pdf'Repite la descarga para cada elemento y conserva nombres locales controlados. Comprueba el tipo de contenido antes de archivar los bytes como PDF.
El nombre de archivo local no usa títulos aportados por usuarios. La versión pending es provisional; no la presentes como el documento final firmado. Consulta el contrato de descarga y conserva la evidencia del proceso que necesite tu aplicación.