واجهة برمجة التطبيقات
القوالب
اسرد القوالب المنشورة التي يستطيع تكاملك الإرسال منها.
تتعامل الواجهة مع القوالب المنشورة — تلك التي جهّزها فريقك ونشرها في قسم القوالب داخل التطبيق. أما المسودات والقوالب المؤرشفة فغير مرئية للواجهة.
سرد القوالب
curl "https://api.instaspace.ai/api/v1/esign/templates?search=nda" \
-H "Authorization: Bearer isk_live_..."المعامل search اختياري ويرشّح حسب الاسم.
{
"templates": [
{
"id": "0b9f6f2e-…",
"name": "Mutual NDA",
"description": "Standard two-party NDA",
"fillMode": "flow",
"submitterRoles": ["First Party", "Second Party"],
"fields": [{ "name": "Signature", "type": "signature", "required": true, "submitterRole": "First Party" }],
"variables": [{ "key": "client_name", "label": "Client Name", "type": "text", "required": true }],
"version": 3
}
]
}جلب قالب واحد
curl https://api.instaspace.ai/api/v1/esign/templates/{id} \
-H "Authorization: Bearer isk_live_..."يعيد الشكل نفسه الذي يعيده عنصر واحد في القائمة. وطلب قالب مسودة أو مؤرشف يعيد 404،
تمامًا كمعرّف غير معروف.
قراءة بنية القالب
هناك عنصران في القالب يحدّدان ما ترسله في طلب التوقيع:
submitterRoles— الأطراف الموقّعة. ويجب أن يسمّي طلب التوقيع مستلمًا واحدًا بالضبط لكل دور.fillModeيقرّر معنىvaluesفي الطلب:flow— القالب مستند يحويvariablesقابلة للملء (اسم العميل، والأتعاب، والتواريخ…). وتكون مفاتيحvaluesلديك هيvariables[].key، وتكتبها إنستاسبيس داخل نصّ المستند نفسه قبل الإرسال.coordinate— القالب يحويfieldsموضوعة بمواضع محدّدة. وتكون مفاتيحvaluesلديك هيnameالخاص بالحقل وتملأ تلك الحقول مسبقًا؛ وما تتركه منها يكمله الموقّع. ولا يمكن ملء حقول التوقيع مسبقًا أبدًا.

