تخطَّ إلى المحتوى الرئيسي
المزايا كيف تعمل الأمان الأسعار التحقق الأسئلة الشائعة
تسجيل الدخول ابدأ مجانًا

التوثيق

مرجع الواجهة البرمجية

أنشئ المستندات وأرسلها للتوقيع وتابع حالتها واستلم الملف المختوم — كل ما تفعله الواجهة، عبر HTTP.

المصادقة

أصدر رمزًا من ملفك الشخصي واختر النطاقات التي يحتاجها التكامل فقط. يُعرض الرمز مرة واحدة ويُخزَّن مُجزّأً، وإن فقدته فأصدر غيره.

أرسله كرمز حامل مع كل طلب. الوصول إلى الواجهة البرمجية جزء من باقتك، ويُفحص مع كل طلب لا عند الإصدار فقط، فيتوقف الرمز عن العمل إن انتهت الباقة.

curl https://tawqee.g4t.io/api/v1/me \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"

النطاقات

الإرسال منفصل عن الإنشاء عن قصد: التكامل الذي يعدّ المستندات لمراجعة بشرية فقط لا ينبغي أن يستطيع عرضها على الطرف الآخر.

documents:read
قراءة المستندات
documents:write
إنشاء المستندات
documents:send
الإرسال للتوقيع
documents:download
تنزيل الملفات المختومة

نقاط النهاية

هذا الجدول مُولَّد من المسارات نفسها، فلا يمكن أن يخالف ما تقدّمه الواجهة فعلًا.

الطريقة المسار النطاق
GET /api/v1/documents documents:read
POST /api/v1/documents documents:write
GET /api/v1/documents/{document} documents:read
GET /api/v1/documents/{document}/sealed documents:download
POST /api/v1/documents/{document}/send documents:send
GET /api/v1/me —
GET /api/v1/templates documents:read
POST /api/v1/templates/{template}/use documents:write

الإنشاء والإرسال في طلب واحد

إحداثيات الحقول كسور من الصفحة تبدأ من الزاوية العلوية، فلا تعتمد على مقاس الورق.

curl -X POST https://tawqee.g4t.io/api/v1/documents \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json" \
  -F "title=Supplier agreement" \
  -F "file=@agreement.pdf" \
  -F "send=1" \
  -F "recipients[0][name]=Layla Al-Harbi" \
  -F "recipients[0][email]=layla@example.com" \
  -F "recipients[0][role]=signer" \
  -F "fields[0][recipient_index]=0" \
  -F "fields[0][page_number]=1" \
  -F "fields[0][type]=signature" \
  -F "fields[0][x]=0.1" -F "fields[0][y]=0.8" \
  -F "fields[0][width]=0.25" -F "fields[0][height]=0.06"

التزويد عبر SCIM

تستطيع حسابات المؤسسات السماح لدليلها بإنشاء المستخدمين وتحديثهم وتعطيلهم عبر SCIM 2.0. الرمز الحامل يخص اتصال دخول موحّد لا شخصًا، وكل ما يصل إليه محصور بنطاق البريد الخاص بذلك الاتصال.

وحذف مستخدم يعطّله. فالحسابات هنا تملك عقودًا موقّعة وسجل تدقيق يُثبت من وقّعها، وإزالة موظف من دليل يجب ألا تزيل ذلك.

https://tawqee.g4t.io/scim/v2

ينقص شيء، أو تتصرف نقطة نهاية بخلاف ما هو مكتوب هنا؟ أخبرنا، فخطأ التوثيق خلل بحد ذاته.

تحدّث إلينا