Pāriet uz galveno saturu
Certyneo
Publiskais API v1

Integrējiet elektronisko parakstu savā tehnoloģijas kaudzē

Nosūtiet aploksnes, izsekojiet parakstus, saņemiet webhook notifikācijas. Vienkāršs REST API, OpenAPI 3.0, curl/Node/Python piemēri — viss, lai pievienotu Certyneo savai HRIS, CRM vai biznesa programmatūrai dažu stundu laikā.

Ātrs sākums

Trīs soļi: izveidojiet API atslēgu no iestatījumiem, kodējiet PDF base64 formātā, nosūtiet. Atbilde satur `signUrl`, ko varat tieši kopīgot ar saņēmēju.

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

Aploksnes

Izveidošana, nosūtīšana, stāvokļa izsekošana, atcelšana. Aploksnē var būt vairāki dokumenti un vairāki parakstītāji (paralēli vai secīgi).

Webhooks

Saņemiet `envelope.created`, `envelope.completed`, `envelope.declined` uz jūsu izvēlēto URL. HMAC SHA-256 katrai darbplūsmai, lai pārbaudītu izcelsmi.

Vienkārša autentifikācija

Bearer marķieris. Viena atslēga katrai videi (tests/prod). Tūlītēji atsaucama. Limits 100 piel./min./atslēga, burst līdz 200, 429 tīrs ar Retry-After galveni.

Pieejamie galapunkti

12 maršruti, kas aptver pilnu ciklu: aploksnes, dokumenti, webhooks, API atslēgas. Visi maršruti pieņem Bearer marķieri un atgriež 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

Plūsmas ierobežojumi

Ierobežojumi nodrošina stabilu pakalpojuma kvalitāti visiem klientiem. Ja jums nepieciešams vairāk, sazinieties ar mums.

  • 100 pieprasījumi minūtē uz API atslēgu
  • Pielauts burst līdz 200 pieprasījumiem mazāk nekā 10 sekundēs
  • 429 atbilde ar Retry-After galveni, norādot aizturi sekundēs