Mur għall-kontenut prinċipali
Certyneo
API pubblika v1

Integra l-firma elettronika fl-stack tiegħek

Ibgħat pakkett, segwi tal-firmi, irċievi webhooks. API REST sempliċi, OpenAPI 3.0, eżempji curl/Node/Python — kollox biex tikkonettja Certyneo mal-HRIS, CRM jew softwer tal-kummerċ tiegħek f'ftit sigħat.

Bidu mabdura

Tliet passaġġi: oħloq ċavetta API mis-settings, kodifika l-PDF tiegħek f'base64, ibgħat. Ir-risposta fiha l-`signUrl` li tista' tqabbel direttament mal-miksub.

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

Envelopp

Ħolqien, missjoni, monitoraġġ tal-istat, kanċellazzjoni. Envelopp waħda tista' tkollu dokumenti multipli u signatarji multipli (paralleli jew sekwenzjali).

Webhooks

Irċievi `envelope.created`, `envelope.completed`, `envelope.declined` fuq l-URL tal-għażla tiegħek. HMAC SHA-256 fuq kull payload biex tivverifika l-oriġini.

Awtentikazzjoni sempliċi

Bearer token. Ċavetta waħda għal kull ambjent (test / prod). Revokabbli istantanju. Limitu 100 req/min/ċavetta, burst ta' 200, 429 ċar b'header Retry-After.

Endpoints disponibbli

12-il rotta li jkopru ċ-ċiklu komplut: envelopes, dokumenti, webhooks, ċwavi API. Ir-rotta kollha jaċċettaw Bearer token u jirritornaw 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

Limiti tal-fluss

Il-limiti jiggarantixxu kwalità ta' servizz stabbli għat-tulħ tal-kliyenti. Jekk għandek bżonn aktar, kontattana.

  • 100 talaba kull minuta għal kull ċavetta API
  • Burst tollerati sa 200 talaba f'inqas minn 10s
  • Risposta 429 b'header Retry-After li jindika d-dewmien f'sekondi