API REST eIDAS

ה-API לחתימת אלקטרונית עבור מפתחים

תשלב חתימה אלקטרונית eIDAS בתוכנה שלך בתוך כמה שעות. REST, webhooks אמין, Node / Python / Ruby SDK, סנדבוקס חינם ללא הגבולות.

ליצור חשבון מפתח תיעוד API

סנדבוקס חינם · 99.95% זמן פעילות · אירוח ריבוני של האיחוד האירופי

REST + OpenAPI 3.1

נקודות קצה צפויות, JSON נקי, קודים HTTP סטנדרטיים, ספק OpenAPI 3.1 ניתן להוריד כדי ליצור לקוחות משלך.

אתרי אינטרנט אמינים

חיפוש אוטומטי עם גיבוי אקפוננטילי, חתימה HMAC SHA-256, יומן אירועים ניתן לחיפוש.

תאימות eIDAS ילידית

חתימות AES, AES-Q ו- QES זמינות דרך API דגל. מסלול ביקורת מוסמך כולל, תעודות TSP מוסמך איחוד האירופה.

דחייה < 200 מיס

API מאוחסן בסטרוסבורג (איחוד האירופי), p95 < 200 ms מאירופה.

תחילת הפעולה בעוד חמש דקות.

תבנו את המעטפה הראשונה שלכם עם בקשה אחת של HTTP.

cURL יצירת מעטפה

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 אחת מספיקה כדי ליצור מעטפה, להוסיף מסמך, חותם וURL של webhook. ה-API מחזירה sign_url מוכן לשתף.

SDK Node.js הרשמי

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

SDK Node TypeScript מספק מיכרים מלאים, טיפול בטעות אוטומטי עם retry, ובונה פדרום נוזלי.

תגובה בזמן אמת

שישה אירועים (envelope.sent, viewed, signed, completed, declined, expired) עם חתימה HMAC שניתן לבדוק וניסיון חוזר אוטומטי.

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 של כל מטען משמש בדוק את האמינות בצד השרת.
ניסיון חוזר אוטומטי אם זה נכשל: 5 ניסיונות ב-24 שעות עם גיבוי אקפוננציאלי.
יומן אירועים שניתן להציג מהמעבר: לראות כל ניסיון, מצב HTTP שהוחזר, הגוף.
URL של webhook שניתן להגדיר על ידי עטיפה או גלובלית בפרויקט.

למה יש לנו API ייעודי לחתימת אלקטרונית?

שילוב החתימה האלקטרונית במוצר שלך הוא לא קל. אתה צריך ערבות על תאימות חוקית (eIDAS), אמינות טכנית (webhooks שבאמת מגיעים), ושלטון נתונים (ארגון אירופי כדי להימנע מחוק הענן).

היא נוצרה על ידי ולטובת מפתחים, והיא עוקבת אחרי הסכמי REST המודרניים: חידוש מבוסס עץ-ישר, מפתחות אידמפוטנציה, חידוש גרסאות לפי URL, OpenAPI 3.1 כדי לייצר את הלקוחות שלך באופן אוטומטי.

תאימות eIDAS מוסבר למפתחים

תקנת eIDAS מגדירה שלושה רמות חתימה: פשוטה (SES), מתקדמת (AES) ומקצועית (QES). ה-Certyneo API מאפשרת לבחור את הרמה על-ידי מעטפה באמצעות שדה `תחתום_level`. הערך המקורי הוא AES (מספיק ל-95% מקרים B2B).

מבחינה טכנית, AES דורש אימות חזק של החותם (OTP באמצעות SMS כברירת מחדל, KYC וידאו כאפשרות) ודרך בדיקה עם אודישן עם אורך זמן. QES מוסיף תעודת איכותי המונחת על ידי TSP מוסמך באיחוד האירופי. כל זה מנוהל על ידי ה-API אתה קורא לנקודת הסיום, אנחנו מטפלים בשאר.

ארכיטקטורה אינטגרציה מומלצת

הדפוס המשתלף ביותר הוא הזרימה הזו:

האתר שלך קורא POST /v1/envelopes כדי ליצור את המעטפה ומקבל sign_url להציג למשתמש.
אתה מעביר את המשתמש אל sign_url או משלב אותו ב-iframe (עם המותג שלך דרך התוכנית הפרו).
לאחר סיום החתימה, Certyneo קורא לוובווק שלך עם האירוע envelope.completed.
אתה מעדכן את מסד הנתונים שלך ומודיע למשתמש (אימייל, אפליקציה, וכו').

סנדבוקס חינם ללא הגבולות

סביבת סנדבוקס היא חינם וחסרת גבולות. כל פונקציות הייצור זמינות, למעט שהחתומים אינם בעלי ערך חוקי (הPDF מסומן SANDBOX). נוח לבדיקות אוטומטיות, הדמוות לקוחות, פיתוח מקומי. מפתחות סנדבוקס נפרדים מפתחות prod, בידוד מוחלט בין השניים.

מהגר מDocuSign או Yousign

אם כבר יש לך אינטגרציה של DocuSign או Yousign, המפות API הן ישירות: מעטפות → מעטפות, יורשים → יורשים, webhooks → webhooks של מצב. מדריך ההגירה שלנו מתעד את השוויון נקודה אחר נקודה.

פער לשאלות API

מה הגבול של ה-API?

1000 בקשות לדקה כברירת מחדל, מוגברת על פי בקשה לשימושים גבוהים (מפעלים, פלטפורמות רב-משתמשים). כותרת X-RateLimit-Remaining על כל תשובה מצביעה על הקוונטה שנותרה. במקרה של מעבר, ה-API מחזירה 429 עם Retry-After.

כמה עולה ה-API?

הכריכה היא ש"הסנדבוקס" הוא חינם וחופשי. הפקה פועלת בתשלום על החתימה (מ 0.40 € החתימה AES עם ירידה בכמות), ללא מנוי מינימלי. תוכנית Enterprise כוללת SLA מחוזק, רשימת לבן IP וחשבון טכני ייעודי.

האם יש ALS?

99.95 אחוז זמן פעילות על תוכניות העסק והארגון (עד 4 שעות הפסקת פעילות בשנה). דף מצב ציבורי עם היסטוריה של תקריות: status.certyneo.com. תוכנית האנטרפרייז כוללת אשראי אוטומטי על הפרת ה-SLA.

איזה אמותה אתה משתמש?

טוקן נושא (מפתח API) בהכותרת אישור. המפתחות ניתן להחליף מדשבורד, עם ביטול מיידי. עבור אינטגרציות OAuth (פלטפורמה רב-משתתף), אנו מציעים OAuth 2.0 אישורים לקוחות על תוכנית הארגון.

איך בודקים את חתימת ה-HMAC של חיבור אינטרנט?

כל webhook כולל כותרת X-Certyneo-Signature המכילה HMAC SHA-256 של המטען, חתום עם webhook הסודי שלך. בצד של השרת, לחשב את HMAC ולהשוות בזמן קבוע (השוואה בטוחה בזמן). SDK הרשמי עושה זאת אוטומטית באמצעות webhook.verify(payload, חתימה, סוד.

האם SDKs הם קוד פתוח?

כן. SDK Node, Python ו- Ruby נמצאים ב- GitHub תחת רישיון MIT. אתה יכול לפורקר, לתרום או פשוט לראיין אותם. הבנריות פורסמו ב- npm, PyPI ו- RubyGems תחת namespace @certyneo / certyneo.

אני יכול לנסות בלי להירשם?

כן, באמצעות הדוגמאות האינטראקטיביות בדוקומנטציה של ה-API: /developers/playground. השאלות שם עוברות נגד דוגמא סנדבוקס משותפת, ללא צורך במפתח. לשימוש רציני, ליצור חשבון מפתחה חינם (סנדבוקס בלתי מוגבל).

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

סנדבוקס חינם ללא הגבלת זמן, תיעוד מלא, ערכות SDK רשמיות.

קרא את המסמכים לדבר עם מפתח Certyneo