Quickstart de integracion partner

Recomendado

Configura una credencial M2M desde la app de Signly, valida headers partner y publica tu primer documento con webhooks activos.

Esta documentacion es para integraciones M2M. Los endpoints `/v1/auth/login` y `/v1/auth/token/refresh` pertenecen al front de Signly App y no deben usarse para integraciones de terceros.

Ruta minima para salir a produccion

Activa Apps & Keys en la app

Un administrador del tenant crea la credencial partner desde Administracion > Apps & Keys. Hoy el metodo habilitado en UI es `KEY` o `HMAC`.

Guarda tenant y secreto

Tu integracion siempre envia `X-Tenant-Signly` y `X-Auth-Signly`. No uses cookies ni sesiones del navegador.

Publica o reutiliza una plantilla

Crea una plantilla, sube el PDF con una URL firmada y versiona cambios cuando ajustes campos o estructura.

Crea el documento

Envia participantes, politicas, orden de firma y fecha limite. El backend devuelve el documento y su estado inicial.

Escucha eventos

Configura webhooks para reaccionar a inicio, OTP, biometria, firma y cierre del proceso sin depender de polling.

Primer request partner

Con una credencial activa puedes validar conectividad listando documentos del tenant.

Primer request partner

curl -X GET "https://api.signly.apologs.com/v1/documents?limit=10" \
  -H "X-Tenant-Signly: tenant_58bff266" \
  -H "X-Auth-Signly: sk_live_partner_abc123"

Coleccion correcta a documentar

La referencia publica debe partir de `SIGNLY_PARTNER`. La coleccion `SIGNLY` pertenece al BFF del front web y no debe usarse como base de una integracion M2M.

Coleccion correcta a documentar

SIGNLY_PARTNER
├─ /v1/documents
├─ /v1/templates
└─ /v1/events/{processId}

SIGNLY
└─ BFF del front web de Signly App
   ├─ /v1/oauth/login
   ├─ /v1/auth/token/refresh
   └─ endpoints de sesion y UI interna

Checklist antes de producir

Define quien crea y rota la credencial partner dentro de tu tenant.
Protege `X-Auth-Signly` como un secreto de servidor. No lo expongas en browser o apps moviles.
Usa webhooks como canal principal de sincronizacion y deja `GET /v1/documents/{documentId}` para consultas puntuales.
Si trabajas con cuentas enterprise o clientes recurrentes, coordina soporte de onboarding con el equipo Signly antes del go-live.

Soporte guiado

El acompanamiento tecnico de implementacion se coordina para cuentas activas con onboarding o clientes enterprise. Si tu equipo necesita ayuda de arquitectura o salida a produccion, escala el caso desde el canal oficial.