Siirry pääsisältöön
Certyneo
Julkinen API v1

Integroi sähköinen allekirjoitus pinoonsa

Lähetä kirjekuoria, seuraa allekirjoituksia, vastaanota webhookeja. Yksinkertainen REST API, OpenAPI 3.0, curl/Node/Python-esimerkit — kaikki mitä tarvitset Certyneoin liittämiseksi HRIS-, CRM- tai muuhun liiketoiminnalliseen ohjelmistoosi muutamassa tunnissa.

Nopea aloitus

Kolme vaihetta: luo API-avain asetuksista, koodaa PDF-tiedostosi base64-muodossa, lähetä. Vastaus sisältää {signUrl}-arvon, jonka voit jakaa suoraan vastaanottajalle.

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

Kirjekuoret

Luominen, lähettäminen, tilanseuraanta, peruutus. Kirjekuori voi sisältää useita asiakirjoja ja useita allekirjoittajia (rinnakkainen tai peräkkäinen).

Webhookit

Vastaanota {envelope.created}, {envelope.completed}, {envelope.declined} valitsemallesi URL:lle. HMAC SHA-256 jokaisessa payloadissa alkuperän tarkistamiseksi.

Yksinkertainen tunnistaminen

Bearer-tunnus. Yksi avain ympäristöä kohden (testi / prod). Peruutettavissa välittömästi. Raja 100 pyyyntöä/min/avain, 200:n purskeilla, siisti 429 Retry-After-otsikolla.

Saatavilla olevat päätepisteet

12 reittiä, jotka kattavat koko syklin: kirjekuoret, asiakirjat, webhookit, API-avaimet. Kaikki reitit hyväksyvät Bearer-tunnuksen ja palauttavat JSON:n.

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

Nopeudenrajoitukset

Rajoitukset takaavat vakaan palvelun laadun kaikille asiakkaille. Jos tarvitset lisää, ota meihin yhteyttä.

  • 100 pyyntöä minuutissa API-avainta kohden
  • Purskeena sallittu jopa 200 pyyntöä alle 10 sekunnissa
  • 429-vastaus Retry-After-otsikolla, joka ilmoittaa viiveen sekunteissa