Siirry pääsisältöön
Certyneo
API REST eIDAS

Kehittäjien sähköisen allekirjoituksen API

REST, luotettavat webhooksit, Node/Python/Ruby SDK, rajoittamaton ilmainen hiekkakenttä.

Ilmainen hiekkakenttä · 99,95 prosentin käyttöaika · EU:n itsenäinen isännöinti

REST + OpenAPI 3.1

Ennustettavissa olevat päätepisteet, puhdas JSON, vakio HTTP-koodit, Spec OpenAPI 3.1 -ladattavissa, jotta voit luoda omat asiakkaansi.

Luotettavat verkkosivut

Automaattinen uudelleenkäsittely, HMAC-kirjaimena SHA-256, tapahtumalogia, ei äänestyskoodia.

EIDAS-muotoinen vaatimustenmukaisuus

AES, AES-Q ja QES- allekirjoitukset saatavilla API-merkin kautta.

Vähintään 200 ms

API-palvelut, jotka on isännöity Strasbourgissa (EU), p95 < 200 ms Euroopasta.

Aloitus 5 minuutin kuluttua.

Luo ensimmäinen kirjekuori yhdellä HTTP-pyynnöllä.

cURL Ulkokirjan luominen
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-kysely on riittävä, jotta voit luoda kirjekuoren, lisätä dokumentin, allekirjoittajan ja webhookin URL:n. API palauttaa sign_urlin, joka on valmiina jakamaan.

Virallinen Node.js 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 tarjoaa täydellisen kirjoituksen, automaattisen virhehallinnan retryllä ja sujuvan kannan rakentajan.

Webhooks reaaliaikainen reagointi

Kuusi tapahtumaa (envelope.sent, viewed, signed, completed, declined, expired) HMAC-kirjaimella, joka voidaan tarkistaa ja joka yrittää uudelleen automaattisesti.

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" }
  ]
}
  • HMAC SHA-256 - allekirjoitus jokaisesta hyödykkeet tarkista serverin puolella.
  • Automaattinen uudelleenkokeilu epäonnistumisen yhteydessä: 5 yritystä 24 tunnin aikana eksponentiaalisella varmuusvarmuudella.
  • Tapahtumatiedot, joita voi katsoa ohjauslaudasta: nähdä jokainen yritys, palautettu HTTP-tila, ruumis.
  • Webhook-URL, joka voidaan määrittää projektin ylikuormitukseksi tai globaalisti.

Miksi käytämme sähköistä allekirjoitusta varten API:tä?

Sähköisen allekirjoituksen integrointi tuotteeseesi on vaikeaa, sillä tarvitset laillista vaatimustenmukaisuutta (eIDAS), teknistä luotettavuutta (tosi-asiaiset webhooks) ja tietosuojakysymystä (Euroopan verkkosivusto Cloud Actin välttämiseksi).

Se on suunniteltu kehittäjien ja kehittäjien hyväksi ja noudattaa nykyaikaisia REST-konventioita: kurssirekisteröinti, idempotency-avaimet, URL-versiointi, OpenAPI 3.1 -ohjelma, joka luo asiakkaita automaattisesti. Ei SOAPia, ei XMLä, ei yllätyksiä.

EIDAS-vaatimustenmukaisuus selvitetty kehittäjille

EIDAS-asetuksessa määritellään kolme allekirjoitustasoa: yksinkertainen (SES), kehittynyt (AES) ja pätevä (QES). Certyneo-API mahdollistaa levelin valitsemisen kirjekuoren kautta `signature_level`-kentän kautta.

Teknisesti AES vaatii vahvaa allekirjoittajan todentamista (OTP tekstiviestillä oletusarvoisesti, KYC video vaihtoehtoisesti) ja aikaleimatun tarkastusmatkan. QES lisää pätevän todistuksen EU:n pätevän TSP:n antaman. Kaikki tämä hoidetaan API:llä soitat päätepisteelle, me hoidamme loput.

Suositeltu integrointirakenne

Yleisin integrointitapaus on seuraava:

  • Takaisinpiste kutsuu POST /v1/envelopes -käytännön luomiseksi ja saa sign_url-osoitteen, jonka se esittää käyttäjälle.
  • Voit ohjata käyttäjän sign_urliin tai upottaa sen iframeen (brändäytymällä Pro-suunnitelman kautta).
  • Kun allekirjoitus on tehty, Certyneo kutsuu webhookilleen enveloppi.completed-tapahtuman.
  • Päivität tietokannasi ja ilmoitat käyttäjälle (sähköposti, sovelluksessa jne.).

Ilmainen, rajoittamaton hiekkakenttä.

Sandbox-ympäristö on ilmainen ja rajoittamaton. Kaikki tuotantotoiminnot ovat käytettävissä, paitsi että allekirjoitukset eivät ole laillisesti voimassa (PDF on merkitty SANDBOXiksi). Kätevä automaattisten testien, asiakasdemojen, paikallisen kehityksen kannalta. Sandbox-avaimet ovat erillisiä prod-avaimista, täydellinen eristäminen niiden välillä.

DocuSignistä tai Yousignista siirtyminen

Jos sinulla on jo DocuSign- tai Yousign-integraatio, API-karttaaminen on suora: kuoret → kuoret, vastaanottajia → vastaanottajia, status webhooks → status webhooks.

Kysymysten torstai API

Mikä on API:n rajoitus?

1 000 kyselyä minuutissa oletusarvoisesti, laajennettavissa pyynnöstä suurille käyttötarkoituksille (tehtaat, moninkertaiset alustat).

Paljonko API maksaa?

Saastekappale on ilmainen ja rajoittamaton. Tuotanto toimii allekirjoittamalla (AES- allekirjoitus 0,40 €:sta ja määrävähennys), ilman vähimmäistilausta.

Onko ALS?

99.95 prosenttia käyttöoikeutta Business- ja Enterprise-suunnitelmissa (enintään 4 tuntia käyttöoikeutta vuodessa). Julkinen tilasivu, jossa on tapahtumien historia: status.certyneo.com. Enterprise-suunnitelmassa on automaattinen luotto SLA-sopimuksen rikkomisesta.

Mitä tunnistusmenetelmää käytät?

OAuth-yhteensopivuudet tarjoavat OAuth 2.0 Client Credentials -ohjelman yrityssuunnitelmassa.

Miten tarkistaa HMAC-signaali verkkouukon?

Jokaisessa webhookissa on X-Certyneo-Signature-otsikko, joka sisältää HMAC:n SHA-256 -käytön, joka on allekirjoitettu salaisella webhookillasi. Palvelimalla lasketaan HMAC:n uudelleen ja verrataan sitä ajankohtaisesti (timing-safe comparison). Virallinen SDK tekee tämän automaattisesti webhook.verify(payload, allekirjoitus, salainen).

Ovatko SDK:t avoimen lähdekoodin ohjelmia?

Kyllä. Node, Python ja Ruby SDK ovat GitHubissa MIT:n lisenssin alaisina. Voit forkeroida, edistää tai vain tarkastaa niitä.

Voinko kokeilla ilman rekisteröintiä?

Kyllä, API-asiakirjojen interaktiivisten esimerkkien kautta: /developers/playground. Kyselyjä käytetään yhteiseen hiekkakonttiin, ei avainta.

Oletko valmis ottamaan sähköisen allekirjoituksen käyttöön?

Ilmainen, rajoittamaton hiekkakontti, täydellinen dokumentti, viralliset SDK:t.