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 مدمجة كلها.

التوقيع بطريقتك

روابط عبر البريد الإلكتروني، أو صفحة مستضافة، أو مكوّن الويب <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. وكل المسارات في هذا التوثيق نسبية إليه.