معاہدہ اندر، دستخط شدہ باہر۔

سب کچھ کیسے جڑتا ہے

ٹیمپلیٹس

PDF (یا Word فائل) اپ لوڈ کریں اور فیلڈز لگائیں، یا Document موڈ میں معاہدہ لکھیں۔ ویری ایبلز ایک JSON Schema ہیں، اس لیے کچھ بھی بھیجنے سے پہلے API آپ کے ڈیٹا کی جانچ کرتا ہے۔ شائع ہونے کے بعد ورژنز تبدیل نہیں ہو سکتے۔

لفافے

ایک POST /v1/envelopes آپ کے ویری ایبلز کے ساتھ ٹیمپلیٹ رینڈر کرتا ہے اور کردار اور ترتیب کے مطابق وصول کنندگان تک روٹنگ شروع کر دیتا ہے۔ ڈرائی رنز، idempotency کیز اور externalId کے ذریعے ڈپلیکیٹ سے بچاؤ پہلے سے شامل ہیں۔

دستخط، آپ کے طریقے سے

ای میل لنکس، ہوسٹ کیا گیا صفحہ، یا آپ کی اپنی ایپ کے اندر <bf-signing> ویب کمپوننٹ (React اور Vue ریپرز کے ساتھ)، جن کے لیے مختصر مدت کے، ایک بار استعمال ہونے والے سیشنز آپ کا بیک اینڈ بناتا ہے۔

ثبوت جسے کوئی بھی چیک کر سکے

ہر مکمل دستاویز کو ایک عوامی ٹائم اسٹیمپ اتھارٹی سے PAdES دستاویزی ٹائم اسٹیمپ ملتا ہے، اور اس کا فنگر پرنٹ ایک Merkle ٹری میں جاتا ہے جس کے روٹس پر Bona Fide، Ed25519 سے دستخط کرتا ہے۔ کوئی بھی کسی نقل کی تصدیق کر سکتا ہے، اکاؤنٹ کی ضرورت نہیں۔

پورا لائف سائیکل ایک نظر میں

1. ڈیش بورڈ میں یا API کے ذریعے ٹیمپلیٹ ڈیزائن کریں، پھر ایک ورژن شائع کریں۔
2. لفافہ بھیجیں: ٹیمپلیٹ کی id، اپنے ویری ایبلز اور ہر کردار کے لیے ایک وصول کنندہ کے ساتھ POST /v1/envelopes۔
3. دستخط: وصول کنندگان کو ای میل لنک ملتا ہے، یا آپ دستخط کا سیشن بنا کر اسے ایمبیڈ کرتے ہیں (delivery: "embedded")۔
4. تکمیل: جب آخری وصول کنندہ دستخط کرتا ہے تو آپ کو ہر ٹائپ کی گئی ویلیو کے ساتھ envelope.completed webhook ملتا ہے۔
5. سیل: سیل شدہ PDF (تکمیل کے سرٹیفکیٹ کے ساتھ) اس وقت تیار ہوتی ہے جب envelope.sealed موصول ہو۔
6. تصدیق: کوئی بھی PDF کو تصدیقی صفحے پر ڈال سکتا ہے یا عوامی تصدیقی API کال کر سکتا ہے۔

API کو خوشگوار کیا بناتا ہے

• ایسے ایررز جن پر عمل کیا جا سکے۔ ہر ایرر RFC 9457 problem+json ہے؛ ویلیڈیشن ایررز میں ہر مسئلے کے لیے ایک JSON Pointer ہوتا ہے، جیسے /variables/client/email۔
• محفوظ ری ٹرائز۔ POST درخواستوں پر Idempotency-Key بھیجیں، تو دوبارہ کوشش پر پہلا جواب ہی واپس ملتا ہے۔
• مفت، لامحدود ٹیسٹ موڈ۔ bf_test_ کیز واٹر مارک والے لفافے بناتی ہیں جن کا کبھی بل نہیں بنتا۔ دیکھیں توثیق۔
• ایسے webhooks جو ایک معیار پر چلتے ہیں۔ ڈیلیوریز پر Standard Webhooks کے مطابق دستخط ہوتے ہیں، تین دن تک دوبارہ کوشش کی جاتی ہے، اور انہیں ری پلے کیا جا سکتا ہے۔
• OpenAPI 3.1، کوڈ سے تیار شدہ۔ حوالہ اور ڈاؤن لوڈ کے قابل openapi.json / openapi.yaml انہی zod کنٹریکٹس سے بنتے ہیں جن سے API ویلیڈیشن کرتا ہے۔

اگلے اقدامات

فوری آغازAPI کلید، ٹیمپلیٹ سے لفافہ، دستخط اور تکمیل کا webhook، دس منٹ میں۔

تصوراتٹیمپلیٹس، کردار، فیلڈز، لفافے، وصول کنندگان، سیشنز اور تنظیمیں۔

ایمبیڈڈ دستخط کے ساتھ دستخط کا تجربہ اپنی پروڈکٹ کے اندر لائیں۔

تصدیقسیلنگ اور اینکرنگ کیسے کام کرتی ہیں، اور کسی دستاویز کو خود کیسے چیک کریں۔

API کا پتہ https://api.bonafidesign.com ہے۔ ان دستاویزات میں تمام پاتھ اسی کے نسبت سے ہیں۔