POST /v1/envelopes

{
  "template": "tpl_mutual_nda",
  "variables": {
    "client": { "name": "Acme Robotics" }
  },
  "recipients": [
    { "role": "client", "name": "Jane Doe",
      "email": "jane@acme.dev" }
  ],
  "delivery": "embedded"
}

201 env_8Gm2kQ4rT1 · sent → completed · sealed

חוזים נכנסים, חתומים יוצאים.

Bona Fide היא חתימה אלקטרונית בתור API. הופכים תבנית ונתונים למעטפה מוכנה לחתימה, נותנים לאנשים לחתום בתוך המוצר שלכם או בדף מאוחסן, ומקבלים PDF נעול שכל אחד יכול לאמת.

התחלה מהירה מדריך עזר ל-API

איך הכול מתחבר

תבניות

מעלים PDF (או קובץ Word) וממקמים שדות, או כותבים את החוזה במצב מסמך. המשתנים מוגדרים כ-JSON Schema, כך שה-API מאמת את הנתונים שלכם לפני שמשהו נשלח. גרסאות שפורסמו אינן ניתנות לשינוי.

מעטפות

קריאת POST /v1/envelopes אחת מרנדרת תבנית עם המשתנים שלכם ומתחילה לנתב אותה לנמענים לפי תפקיד וסדר. הרצות ניסיון, מפתחות אידמפוטנטיות ומניעת כפילויות לפי externalId מובנים.

חתימה בדרך שלכם

קישורים באימייל, דף מאוחסן או רכיב ה-Web Component <bf-signing> (עם עטיפות ל-React ול-Vue) בתוך האפליקציה שלכם, עם סשנים קצרי חיים לשימוש חד-פעמי שהשרת שלכם יוצר.

ראיות שכל אחד יכול לבדוק

כל מסמך שהושלם מקבל חותמת זמן מסמך מסוג PAdES מרשות חותמות זמן ציבורית, וטביעת האצבע שלו נכנסת לעץ Merkle ש-Bona Fide חותמת על שורשיו ב-Ed25519. כל אחד יכול לאמת עותק, בלי צורך בחשבון.

מחזור החיים בתמונה אחת

מעצבים תבנית בלוח הבקרה או דרך ה-API, ואז מפרסמים גרסה.
שולחים מעטפה: POST /v1/envelopes עם מזהה התבנית, המשתנים שלכם ונמען אחד לכל תפקיד.
חותמים: הנמענים מקבלים קישור באימייל, או שאתם יוצרים סשן חתימה ומטמיעים אותו (delivery: "embedded").
משלימים: כשהנמען האחרון חותם, מתקבל webhook מסוג envelope.completed עם כל ערך שהוזן.
נועלים: קובץ ה-PDF הנעול (עם אישור ההשלמה) מוכן כשמגיע envelope.sealed.
מאמתים: כל אחד יכול לגרור את קובץ ה-PDF אל דף האימות או לקרוא ל-API האימות הציבורי.

מה הופך את ה-API לנוח

שגיאות שאפשר לפעול לפיהן. כל שגיאה היא RFC 9457 problem+json; שגיאות אימות כוללות JSON Pointer לכל בעיה, למשל /variables/client/email.
ניסיונות חוזרים בטוחים. שולחים Idempotency-Key בבקשות POST, וניסיון חוזר מחזיר שוב את התגובה הראשונה.
מצב בדיקה חינמי וללא הגבלה. מפתחות bf_test_ יוצרים מעטפות עם סימן מים שלעולם אינן מחויבות. ראו הזדהות.
Webhooks שפועלים לפי תקן. המשלוחים נחתמים לפי Standard Webhooks, נשלחים שוב במשך שלושה ימים, ואפשר להפעיל אותם מחדש.
OpenAPI 3.1, שנוצר מהקוד. מדריך העזר והקבצים להורדה openapi.json / openapi.yaml נבנים מאותם חוזי zod שבהם ה-API מאמת.

השלבים הבאים

התחלה מהירהמפתח API, מעטפה מתבנית, חתימה ו-webhook ההשלמה בעשר דקות.

מושגיםתבניות, תפקידים, שדות, מעטפות, נמענים, סשנים וארגונים.

חתימה מוטמעתחוויית החתימה בתוך המוצר שלכם עם .

אימותאיך פועלות הנעילה והעיגון, ואיך בודקים מסמך בעצמכם.

ה-API זמין בכתובת https://api.bonafidesign.com. כל הנתיבים בתיעוד הזה יחסיים אליה.