Tu primera solicitud

Comprueba la conexión y el equipo de tu clave con una solicitud de lectura. Al terminar tendrás una lista de sobres y los datos necesarios para consultar uno de ellos.

Antes de empezarCopiar link al encabezado

• Una clave del equipo guardada en DIGITO_API_TOKEN en el entorno de tu servidor.
• cURL para la terminal, o Node.js con fetch para TypeScript.
• Acceso al equipo que quieres consultar. La clave determina el alcance; el ID de un recurso no concede acceso.

Configura la autenticación si todavía no tienes una clave. Todos los ejemplos usan la base https://business.digito.do/api/v2.

Lista tus documentosCopiar link al encabezado

curl --fail-with-body --get \
  'https://business.digito.do/api/v2/envelope' \
  -H "Authorization: $DIGITO_API_TOKEN" \
  --data-urlencode 'type=DOCUMENT' \
  --data-urlencode 'page=1' \
  --data-urlencode 'perPage=10'

Guarda el bloque TypeScript en primera-solicitud.ts y ejecútalo con node primera-solicitud.ts en una versión de Node.js que admita TypeScript. Los tipos locales describen los campos que consume el ejemplo; no validan datos externos en ejecución. El tiempo de espera de 15 segundos es una elección del cliente.

Entiende la respuestaCopiar link al encabezado

Los campos de paginación están en el nivel superior, junto a data. Esta es una respuesta completa válida para un equipo sin documentos:

{
  "data": [],
  "count": 0,
  "currentPage": 1,
  "perPage": 10,
  "totalPages": 0
}

Una lista vacía con una respuesta correcta también confirma que la clave funciona. Si esperabas documentos, comprueba el equipo de la clave y tus filtros.

Con resultados, cada elemento incluye más propiedades. Esta selección muestra solamente los campos que necesita la vista de ejemplo; no representa el objeto completo:

{
  "id": "envelope_ejemplo",
  "title": "Contrato de servicios",
  "teamId": 42,
  "type": "DOCUMENT",
  "status": "DRAFT",
  "externalId": "contrato-001"
}

El id del sobre es texto. Los IDs de destinatarios y campos son números. Guarda cada identificador con el tipo que devuelve su operación.

Consulta un sobre concretoCopiar link al encabezado

Sustituye envelope_ejemplo por un id de la lista:

curl --fail-with-body \
  'https://business.digito.do/api/v2/envelope/envelope_ejemplo' \
  -H "Authorization: $DIGITO_API_TOKEN"

El detalle añade envelopeItems y fields, entre otros datos. Los envelopeItems[].id identifican PDFs; no son IDs del sobre ni del destinatario.

Si la consulta fallaCopiar link al encabezado

La disponibilidad de cada código depende de la operación. Consulta la referencia de listado para sus parámetros y respuestas.

Continúa con un borradorCopiar link al encabezado

Prepara tu primer documento para cargar un PDF, asignar un destinatario y colocar un campo de firma sin distribuir el sobre.