Comhtháthú sínithe leictreonacha i do stack
Seol clúdaigh, lean na sínithe, faigh webhooks. API REST simplí, OpenAPI 3.0, samplaí curl/Node/Python — an méid ar fad chun Certyneo a cheangal ar do HRIS, CRM nó bhogearraí gníomhaíochta i roinnt uaireanta.
Tosú gasta
Trí chéim : cruthaigh eochair API ó na socruithe, ionchódaigh do PDF i mbonn64, seol. Tá an `signUrl` san fhreagra ar féidir leat a roinnt go díreach leis an spriocdhíneadh.
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>" }
]
}'// 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);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"])Clúdaigh
Cruthú, seolradh, rianú stádas, cealú. Is féidir le clúdach iomláine doiciméad agus iolrú sínitheoir a bheith ann (comhthreomhar nó seicheamhail).
Webhooks
Faigh `envelope.created`, `envelope.completed`, `envelope.declined` ar an URL is rogha leat. HMAC SHA-256 ar gach payload chun an fhoinse a fhíorú.
Fíorú simplí
Bearer token. Eochair amháin in aghaidh an timpeallachta (tástáil / prod). In-dhíobhála ar an toirt. Teorainn 100 req/min/eochair, scréachail 200, 429 glan le ceannlíne Retry-After.
Endpoints ar fáil
12 slat a chlúdaíonn an timthriall iomlán : clúdaigh, doiciméad, webhooks, eochracha API. Glacann gach slat Bearer token agus filleann JSON.
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/envelopes | List envelopes |
| POST | /api/v1/envelopes | Create + send |
| GET | /api/v1/envelopes/{id} | Fetch state |
| DELETE | /api/v1/envelopes/{id} | Void |
| POST | /api/v1/envelopes/{id}/send | Re-trigger send |
| GET | /api/v1/documents | List documents |
| GET | /api/v1/webhooks | List webhooks |
| POST | /api/v1/webhooks | Register webhook |
| DELETE | /api/v1/webhooks/{id} | Unregister |
| GET | /api/v1/keys | List API keys |
| POST | /api/v1/keys | Create API key |
| DELETE | /api/v1/keys/{id} | Revoke key |
Teorainneacha ar an ráta
Ráthaíonn na teorainneacha caighdeán seirbhíse cobhsaí do gach cliant. Má theastaíonn níos mó uait, teagmháil linne.
- • 100 iarratas in aghaidh an nóiméid in aghaidh an eochair API
- • Scréachail a raibh glacadh ann go dtí 200 iarratas in níos lú ná 10s
- • Freagra 429 le ceannlíne Retry-After ag sonrú an sprioca i soicindí