Anar al contingut principal
Certyneo
API pública v1

Integreu la signatura electrònica al vostre stack

Envieu envolupants, seguiu les signatures, rebeu webhooks. API REST senzilla, OpenAPI 3.0, exemples curl/Node/Python — tot per connectar Certyneo al vostre HRIS, CRM o programari empresarial en poques hores.

Inici ràpid

Tres passos: creeu una clau API des dels paràmetres, codifiqueu el vostre PDF en base64, envieu. La resposta conté el `signUrl` que podeu compartir directament amb el destinatari.

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"])

Envolupants

Creació, enviament, seguiment d'estat, cancel·lació. Una envolupant pot contenir diversos documents i diversos signataris (paral·lel o seqüencial).

Webhooks

Rebeu `envelope.created`, `envelope.completed`, `envelope.declined` a l'URL de la vostra elecció. HMAC SHA-256 a cada payload per verificar l'origen.

Autenticació senzilla

Bearer token. Una clau per entorn (test / prod). Revocable instantàniament. Límit de 100 req/min/clau, burst de 200, 429 net amb capçalera Retry-After.

Punts finals disponibles

12 rutes que cobreixen el cicle complet: envelopes, documents, webhooks, claus API. Totes les rutes accepten un Bearer token i retornen 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ímits de cabal

Els límits garanteixen una qualitat de servei estable per a tots els clients. Si necessiteu més, poseu-vos en contacte amb nosaltres.

  • 100 sol·licituds per minut per clau API
  • Burst tolerat fins a 200 sol·licituds en menys de 10s
  • Resposta 429 amb capçalera Retry-After indicant el retard en segons