Siirdu põhisisu juurde
Certyneo
Avalik API v1

Integreerige elektrooniline allkirjastamine oma stacki

Saatke ümbrikud, jälgige allkirjastamist, vastuvõtke webhookid. Lihtne REST API, OpenAPI 3.0, curl/Node/Python näited — kõik, mis on vaja Certyneo ühendamiseks oma HRIS-i, CRM-i või ärisoftvariga mõne tunniga.

Kiire alustamine

Kolm sammu: looge API võti seadetest, kodeerige oma PDF base64-ks, saatke. Vastus sisaldab `signUrl`-i, mille saate otseselt adressaadiga jagada.

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

Ümbrikud

Loomine, saatmine, oleku jälgimine, tühistamine. Ümbrik võib sisaldada mitut dokumenti ja mitut allkirjastajat (paralleelselt või järjestikku).

Webhookid

Saatke `envelope.created`, `envelope.completed`, `envelope.declined` oma valitud URL-ile. HMAC SHA-256 iga last valideerimiseks.

Lihtne autentimine

Bearer token. Üks võti keskkonna kohta (test / prod). Kohe tühistatav. Piir 100 nõuet/min/võti, 200-kuni plahvatus, puhas 429 Retry-After päisega.

Saadaolevad otspunktid

12 marsruuti, mis katavad täieliku tsükli: ümbrikud, dokumendid, webhookid, API võtmed. Kõik marsruudid aktsepteerivad Bearer tokenit ja tagastavad JSON-i.

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

Debiitkiirusepiired

Piirid garanteerivad stabiilset teenuste kvaliteeti kõigile klientidele. Kui vajate rohkem, võtke meiega ühendust.

  • 100 nõuet minutis API võtme kohta
  • Plahvatus kuni 200 nõudeni vähem kui 10 sekundis
  • 429 vastus Retry-After päisega, mis näitab viivitust sekundites