דלג לתוכן ראשי
Certyneo
API ציבורית v1

שלבו חתימה אלקטרונית בחבילה שלכם

שלחו מעטפות, עקבו אחר חתימות, קבלו webhooks. REST API פשוטה, OpenAPI 3.0, דוגמאות curl/Node/Python — הכל כדי לחבר את Certyneo לשלכם HRIS, CRM או תוכנת עסק בתוך כמה שעות.

התחלה מהירה

שלוש שלבים: צרו מפתח API מההגדרות, קודדו את ה-PDF שלכם ב-base64, שלחו. התשובה מכילה את `signUrl` שאתם יכולים לשתף ישירות עם הנמען.

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

מעטפות

יצירה, שליחה, עקיבת מצב, ביטול. מעטפה יכולה להכיל מספר מסמכים ומספר חותמים (במקביל או בסדר רציף).

Webhooks

קבלו `envelope.created`, `envelope.completed`, `envelope.declined` ל-URL של בחירתכם. HMAC SHA-256 על כל payload כדי לאמת את המקור.

אימות פשוט

Bearer token. מפתח אחד לכל סביבה (בדיקה / ייצור). ניתן לשלילה מיידית. הגבלה של 100 בקשות/דקה/מפתח, burst של 200, 429 נקי עם כותרת Retry-After.

Endpoints זמינים

12 נתיבים המכסים את המחזור המלא: mvelopes, documents, webhooks, מפתחות API. כל הנתיבים מקבלים Bearer token ומחזירים 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

הגבלות קצב

ההגבלות מבטיחות איכות שירות יציבה לכל הלקוחות. אם אתם צריכים יותר, צרו איתנו קשר.

  • 100 בקשות לדקה לפי מפתח API
  • Burst מותר עד 200 בקשות בפחות מ-10 שניות
  • תשובת 429 עם כותרת Retry-After המציינת את ההשהיה בשניות