Primeros pasos con la API
Usar /api para consultar la referencia navegable y /api/v1/openapi.json para obtener el contrato. La raíz de integración actual es /api/v1. Documentación leída en a93224a; los ejemplos siguientes no se ejecutaron contra el sandbox.
- Entrar a Integrations en la consola y crear un token con los alcances necesarios.
- Mantenerlo en el servidor de la integración; no incluirlo en código de navegador, capturas ni repositorios.
- Comenzar con una lectura de
/api/v1/meusandoAuthorization: Bearer <token>. - Consultar
/api/v1/workflowsy el detalle/api/v1/workflows/{id}. - Para crear el flujo, consultar en OpenAPI la subida
/documents, la configuración del workflow, sus signers y la operación/dispatch. Usar los cuerpos y métodos del contrato, no los identificadores internos de tablas. - Las rutas
/documents/{id}/...reciben el identificador de instancia. No sustituirlo por el del workflow.
Ejemplo de lectura, con dominio reservado y token de marcador; sustituirlos sólo en el entorno local de la integración:
curl --header 'Authorization: Bearer <TOKEN_DE_API>' 'https://signing.example/api/v1/me'Para operaciones con reintentos, seguir la especificación de Idempotency-Key de OpenAPI. Conservar la misma clave para reintentar la misma operación, y examinar la respuesta antes de generar otra. Consultar los códigos y cuerpos de error en la referencia de cada ruta.
Los webhooks se configuran en Integrations. La lista de eventos está en /api/v1/event-types. Las propiedades de evidencia o validez vinculadas a eventos y descargas se remiten a la fuente de garantías y su alcance documentado; no deducirlas del nombre de un evento.
Fuentes: OpenAPI, fuente del contrato, rutas, traducción al inglés. No se duplica aquí el catálogo de parámetros para evitar dos referencias que diverjan.