Przejdź do zawartości głównej
Certyneo
Publiczne API v1

Zintegruj podpis elektroniczny w swoim stosie technologicznym

Wysyłaj koperty, śledź podpisy, odbieraj webhoki. Proste API REST, OpenAPI 3.0, przykłady curl/Node/Python — wszystko, aby podłączyć Certyneo do swojego HRIS, CRM lub oprogramowania biznesowego w kilka godzin.

Szybki start

Trzy kroki: utwórz klucz API z ustawień, zakoduj swój PDF w base64, wyślij. Odpowiedź zawiera `signUrl`, którą możesz bezpośrednio udostępnić odbiorcy.

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

Koperty

Tworzenie, wysyłanie, śledzenie stanu, anulowanie. Koperta może zawierać wiele dokumentów i wielu signatariuszy (równolegle lub sekwencyjnie).

Webhoki

Odbieraj `envelope.created`, `envelope.completed`, `envelope.declined` na wybranym przez Ciebie adresie URL. HMAC SHA-256 na każdym payload dla weryfikacji pochodzenia.

Proste uwierzytelnianie

Bearer token. Jeden klucz na środowisko (test / prod). Natychmiast odwoływalny. Limit 100 req/min/klucz, burst do 200, czysty kod 429 z nagłówkiem Retry-After.

Dostępne endpointy

12 ścieżek obejmujących pełny cykl: koperty, dokumenty, webhoki, klucze API. Wszystkie ścieżki akceptują Bearer token i zwracają JSON.

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

Limity szybkości

Limity gwarantują stabilną jakość usług dla wszystkich klientów. Jeśli potrzebujesz więcej, skontaktuj się z nami.

  • 100 żądań na minutę na klucz API
  • Burst tolerowany do 200 żądań w mniej niż 10s
  • Odpowiedź 429 z nagłówkiem Retry-After wskazującym opóźnienie w sekundach