RESTO API
Las llamadas de servidor a servidor utilizan `Autorización: Portador esk_test_…` o `esk_live__…`. El inquilino viene de la llave. La carga, el asistente de sobres y el registro webhook utilizan la sesión de administrador.
Qué puede llamar un inquilino con la clave API
| Llamar | Alcance en la llave | Lo que obtienes a cambio |
|---|---|---|
| GET /api/v1/zapier/auth/test | integrations:zapier | Su identificación y nombre de inquilino. Utilice esto para confirmar la clave. |
| GET /api/v1/zapier/triggers/{event}/sample | integrations:zapier | Cargas útiles de muestra para documento.firmado, documento.completado, documento.expirado y plantilla.creada. |
| POST /api/v1/zapier/actions/create-from-template | integrations:zapier | Una nueva identificación de documento de una plantilla que ya tienes. |
| POST /api/v1/zapier/actions/send-for-signing | integrations:zapier | El documento pasa a enviado por enlace y se envía un correo electrónico al firmante. |
| POST /api/v1/signing-sessions/{sessionId}/tokens | signing:write | Un token st_… de corta duración para la inserción. El navegador usa ese token, no la clave API. |
Sesión de administrador
Inicie sesión en la aplicación de administración para estos. Se rechaza una clave de portador API en estas rutas.
| Trabajo | Dónde |
|---|---|
| Subir un PDF, clientes, plantillas | Documentos administrativos y clientes |
| Asistente de sobres: crear, enviar, cancelar | Sobres de administración |
| Registrar, rotar y reproducir webhooks | Admin → Desarrollador → Webhooks |
Confirme la clave y luego envíe un documento de plantilla
Requisitos previos: una clave `esk_test_…` o `esk_live__…` con `integrations:zapier` y una identificación de plantilla. Resultado esperado: HTTP 200 de la prueba de autenticación, HTTP 201 con `documentId`, luego `status: "link-sent"`.
curl -sS https://api.endorsedsign.com/api/v1/zapier/auth/test \
-H "Authorization: Bearer $ENDORSED_API_KEY"
curl -sS -X POST https://api.endorsedsign.com/api/v1/zapier/actions/create-from-template \
-H "Authorization: Bearer $ENDORSED_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"templateId": "'"$ENDORSED_TEMPLATE_ID"'",
"recipientEmail": "signer@example.com",
"recipientName": "Signer Example"
}'
curl -sS -X POST https://api.endorsedsign.com/api/v1/zapier/actions/send-for-signing \
-H "Authorization: Bearer $ENDORSED_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"documentId": "'"$ENDORSED_DOCUMENT_ID"'",
"channel": "email"
}'Las nuevas integraciones deben llamar a `/api/v1/…` o `/api/v2/…`. `/api/v2` es el contrato del 1 de septiembre de 2026. Las llamadas mutantes que lo admitan deben enviar "Idempotency-Key".
Preguntas comunes
API claves en el espacio de trabajo del desarrollador inquilino
Cree una clave con nombre, asigne ámbitos y vea el prefijo en el mismo Chrome de administración que sus operadores ya usan.
SDK inicios rápidos junto a las credenciales activas
Los operadores pueden rotar claves y transferir la incorporación SDK específica del idioma desde el mismo espacio de trabajo de desarrollador inquilino.
Espacio de trabajo para desarrolladores con datos en vivo
Una única superficie de desarrollador que muestra los controles clave del inquilino activo API en el espacio de trabajo de administración.
Obtén tu clave API en una llamada
POST /api/auth/register with `mode: sandbox` returns an `esk_test_` key. Confirm it with GET /api/v1/zapier/auth/test. OpenAPI is at /api/docs.json on an API host that has docs enabled.