Siirdu põhisisu juurde
Certyneo
API REST eIDAS

E-allkirja API arendajatele

REST, usaldusväärsed veebikõnetused, Node/Python/Ruby SDK, piiramatu tasuta liivakast.

Loe arendaja konto API dokumentatsioon

Tasuta liivakast · 99,95% tööaega · ELi suveräänne hosting

REST + OpenAPI 3.1

Eeldatavad lõpppunktid, puhas JSON, standard HTTP koodid, Spec OpenAPI 3.1 alla laaditav, et luua oma kliendid.

Usaldusväärsed veebisisulehed

Automaatne otsing, eksponentsiaalne tagasilükkamine, HMAC allkiri SHA-256, uuritav sündmuste log, pole valitud hääletusi.

EIDASi vastavus

AES-, AES-Q- ja QES-allkirjad on kättesaadavad API-lipu kaudu.

Lähenemine < 200 ms

API majutatud Strasbourgis (EL), p95 < 200 ms Euroopast.

Alustame viie minuti pärast.

Looge oma esimene ümbrik ühe HTTP päringuga.

cURL Konverentsi loomine
curl https://api.certyneo.com/v1/envelopes \
  -H "Authorization: Bearer $CERTYNEO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Contrat de prestation",
    "documents": [{"file_url": "https://your.app/contract.pdf"}],
    "recipients": [{"email": "client@example.com", "name": "Jane Doe"}],
    "webhook_url": "https://your.app/webhooks/sign"
  }'

POST-küsimuse abil saab luua ümbrik, lisada dokumendi, allkirjaja ja webhooki URL. API tagastab jagamiseks valmis sign_url.

Node.js ametlik SDK
import Certyneo from '@certyneo/sdk';

const client = new Certyneo({ apiKey: process.env.CERTYNEO_API_KEY });

const envelope = await client.envelopes.create({
  title: 'Contrat de prestation',
  documents: [{ file_url: 'https://your.app/contract.pdf' }],
  recipients: [{ email: 'client@example.com', name: 'Jane Doe' }],
});

console.log(envelope.sign_url); // ready to share with the signer

Node TypeScript SDK pakub täielikku kirjutamist, automaatset eksimehhanismi ja sujuvat ümbruse ehitajat.

Webhook reaalajas reageeri

Kuus sündmust (envelope.sent, viewed, signed, completed, declined, expired) HMAC-tunnustatud allkirjaga ja automaatselt uuesti proovida.

envelope.completed
{
  "event": "envelope.completed",
  "envelope_id": "env_3a2f...",
  "signed_at": "2026-05-25T14:32:18Z",
  "evidence_url": "https://api.certyneo.com/v1/envelopes/env_3a2f.../audit-trail.pdf",
  "signers": [
    { "email": "client@example.com", "signed": true, "ip": "82.x.x.x" }
  ]
}
  • Iga laeva HMAC SHA-256 allkiri Serveri poolt autentimine.
  • Automaatne uuesti proovimine ebaõnnestumise korral: 5 katset 24 tunnis eksponentsiaalse varukoormusega.
  • Juhtumite log, mida saab vaadata paneelilt: vaadake iga katset, tagastatud HTTP staatust, keha.
  • Projekti ülekandmiseks või ülemaailmseks konfigureeritav webhook URL.

Miks peaksin ma tegema e-allkirja API?

Elektroonilise allkirja integreerimine oma toodetesse on raske.Te vajate õigusliku vastavuse tagatisi (eIDAS), tehnilist usaldusväärsust (tõeliselt saabuvad veebikõnad) ja andmesovaldust (Euroopa majutus pilveakti vältimiseks).Certyneo API katab kõik kolm.

See on loodud arendajate poolt ja arendajate jaoks ning järgib tänapäeva REST-konventsioone: kursoripõhine pagineerimine, idempotency võtmed, URL-versioonimine, OpenAPI 3.1 klientide automaatseks genereerimiseks.

EIDASi vastavus selgitatud arendajatele

Certyneo API võimaldab valida taseme ümbriku kaudu väljal `allkirja_taseme` kaudu. Eeldatav on AES (piisav 95% B2B juhtudest). QES on saadaval dokumentidele, mis vajavad ranget õiguslikku samaväärsust käsitsi kirjutatud allkirjaga (notariaatlikud dokumendid, riigihanked).

Tehniliselt nõuab AES tugevat allkirjastamist (OTP SMS-i teel vaikimisi, KYC video valikuliselt) ja kellaline auditi jälg. QES lisab kvalifitseeritud sertifikaadi, mille annab ELi kvalifitseeritud TSP. Kõik see on haldatud API-ga helistage lõpppunktile, ülejäänu hoolitseme meie eest.

Soovitatav integreerimisarhitektuur

Kõige tavalisem integreerumispaar on selline:

  • Teie tagumik kutsub POST /v1/envelopes'i, et luua ümbrik ja saab sign_url'i, mida esitada kasutajale.
  • Sa suunad kasutaja sign_urlile või paned selle iframe'i (pro-plaani kaudu oma brändiga)
  • Kui allkiri on valmis, kutsub Certyneo teie veebisikule envelope.completed sündmusega.
  • Sa uuendad oma andmebaasi ja teavitad kasutajat (e-posti, rakenduses jne).

Tasuta Sandbox piiramatu

Sandbox on tasuta ja piiramatu keskkond. Kõik tootmise funktsioonid on kättesaadavad, välja arvatud allkirjad, millel ei ole juriidilist väärtust (PDF on märgitud SANDBOX).

DocuSignist või Yousignist rände

Kui teil on juba DocuSign või Yousign integreeritud, on API kaardistamine lihtne: ümbrikud → ümbrikud, vastuvõtjad → vastuvõtjad, webhookide staatuse → webhookide staatuse.

Küsimuste koht API

Mis on API piir?

1000 päringut minutis vaikimisi, suureneb nõudmisel suurte kasutusviiside puhul (tehased, mitmetel kasutajatel).

Kui palju API maksab?

Tootmine toimub sisselogimisel (AES-le allkirjastamine algab 0,40 € ja väheneb mahuga), ilma minimaalse tellimuseta.

Kas ALS on olemas?

99.95% tööaega äri- ja ettevõtlusplaanidel (maksimaalselt 4 tundi tööaega aastas). Avalik olukorra lehekülg, kus on juhtumite ajalugu: status.certyneo.com. Ettevõtlusplaan sisaldab automaatset krediiti, kui SLA ei ole täidetud.

Millist autentimist te kasutate?

OAuth-i integreerimiseks pakume ettevõtlusplaanis OAuth 2.0 Kliendi Kredientide süsteemi.

Kuidas kontrollida veebisingu HMAC allkirja?

Iga veebhook sisaldab X-Certyneo-Signature pealkirja, mis sisaldab laekumi SHA-256 HMAC-d, mis on allkirjastatud teie salajaste veebhookidega.

Kas SDKd on avatud lähtekoodiga?

Jah. Node, Python ja Ruby SDKd on GitHubil MIT litsentsil. Saate neid forkerida, kaasa aidata või lihtsalt auditeerida. Binaarid on avaldatud npm, PyPI ja RubyGems'i nimruumis @certyneo / certyneo.

Kas ma võin ilma registreerimata testida?

Jah, läbi interaktiivsete näiteid API dokumentatsioonist: /developers/playground. Küsimused liiguvad seal jagatud sandbox-i instantsi vastu, mille jaoks ei ole vaja võtmet. Tõsise kasutamise korral looge tasuta arendaja konto (piiritu sandbox).

Kas olete valmis e-allkirja panema?

Piiramatu tasuta liivakast, täielik dokumentatsioon, ametlik SDK.

Lugege dokumendid Räägi Certyneo arendajaga