Ir al contenido principal
Certyneo
API pública v1

Integra la firma electrónica en tu stack

Envía sobres, sigue las firmas, recibe webhooks. API REST simple, OpenAPI 3.0, ejemplos curl/Node/Python — todo para conectar Certyneo con tu HRIS, CRM o software empresarial en pocas horas.

Inicio rápido

Tres pasos: crea una clave API desde la configuración, codifica tu PDF en base64, envía. La respuesta contiene el `signUrl` que puedes compartir directamente con el destinatario.

cURLbash
curl -X POST https://certyneo.com/api/v1/envelopes \
  -H "Authorization: Bearer ck_live_xxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": "Contrat de prestation",
    "signers": [
      { "email": "[email protected]", "name": "Marie Dubois" }
    ],
    "documents": [
      { "name": "contrat.pdf", "base64Pdf": "<base64>" }
    ]
  }'
JavaScript / Nodets
// npm install @certyneo/sdk  (or call fetch directly)
const r = await fetch("https://certyneo.com/api/v1/envelopes", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.CERTYNEO_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    subject: "Contrat de prestation",
    signers: [{ email: "[email protected]", name: "Marie Dubois" }],
    documents: [{ name: "contrat.pdf", base64Pdf }],
  }),
});
const envelope = await r.json();
console.log(envelope.id, envelope.signers[0].signUrl);
Pythonpython
import requests, base64, os

with open("contrat.pdf", "rb") as f:
    base64_pdf = base64.b64encode(f.read()).decode()

r = requests.post(
    "https://certyneo.com/api/v1/envelopes",
    headers={"Authorization": f"Bearer {os.environ['CERTYNEO_API_KEY']}"},
    json={
        "subject": "Contrat de prestation",
        "signers": [{"email": "[email protected]", "name": "Marie Dubois"}],
        "documents": [{"name": "contrat.pdf", "base64Pdf": base64_pdf}],
    },
)
envelope = r.json()
print(envelope["id"], envelope["signers"][0]["signUrl"])

Sobres

Creación, envío, seguimiento de estado, cancelación. Un sobre puede contener varios documentos y varios firmantes (en paralelo o secuencial).

Webhooks

Recibe `envelope.created`, `envelope.completed`, `envelope.declined` en la URL de tu elección. HMAC SHA-256 en cada payload para verificar el origen.

Autenticación simple

Bearer token. Una clave por entorno (test / prod). Revocable instantáneamente. Límite 100 req/min/clave, burst de 200, 429 limpio con encabezado Retry-After.

Endpoints disponibles

12 rutas que cubren el ciclo completo: sobres, documentos, webhooks, claves API. Todas las rutas aceptan un Bearer token y devuelven JSON.

MethodPathDescription
GET/api/v1/envelopesList envelopes
POST/api/v1/envelopesCreate + send
GET/api/v1/envelopes/{id}Fetch state
DELETE/api/v1/envelopes/{id}Void
POST/api/v1/envelopes/{id}/sendRe-trigger send
GET/api/v1/documentsList documents
GET/api/v1/webhooksList webhooks
POST/api/v1/webhooksRegister webhook
DELETE/api/v1/webhooks/{id}Unregister
GET/api/v1/keysList API keys
POST/api/v1/keysCreate API key
DELETE/api/v1/keys/{id}Revoke key

Límites de velocidad

Los límites garantizan una calidad de servicio estable para todos los clientes. Si necesitas más, contáctanos.

  • 100 solicitudes por minuto por clave API
  • Burst tolerado hasta 200 solicitudes en menos de 10s
  • Respuesta 429 con encabezado Retry-After indicando el retraso en segundos