WQ3 API
قدرات التوقيع في WQ3، متاحة داخل تطبيقاتك وأنظمتك.
المطوّرون
واجهة WQ3 البرمجية
واجهة REST تنشئ بها المستندات، وتضيف الموقّعين، وترسلها للتوقيع، وتنزّل النسخ الموقّعة.
آلية العمل
01ينشئ نظامك المستند.
02يرسله WQ3 إلى الموقّعين بالتتابع.
03يوقّع الموقّعون.
04يستلم نظامك النسخة الموقّعة.
مثال على طلب
مثال لطلب يرسل مستندًا إلى موقّعَين بالتتابع.
للتوضيح فقط، ويُتاح التوثيق الكامل لعملاء الواجهة البرمجية.
صفحات ذات صلة
التكاملات
اربط WQ3 بأنظمة ERP والموارد البشرية وإدارة العملاء والتخزين، أو اطلب تكاملًا مخصّصًا.
لنبدأ التكامل معًا.
أخبرنا بما تريد بناءه، وسنزوّدك بتفاصيل الوصول إلى الواجهة البرمجية.
القدرات الرئيسية
المستندات
رفع الملفات أو إنشاؤها من القوالب.
الموقّعون
تحديد الأطراف والترتيب ومستوى التوقيع لكل منهم.
النتائج
تنزيل الملف المختوم وشهادة الإتمام.
حدّد سياسة التوقيع قبل ربطها بالواجهة
ابدأ بقواعد العمل التي تحدد من يوقّع كل نوع من المستندات، ومستوى التوقيع المطلوب لكل طرف. يتيح وقع استخدام مستويات مختلفة للموقّعين في المستند نفسه؛ لذلك يُفضّل أن يربط تطبيقك المستوى بدور الموقّع ومتطلبات الاتفاقية، بدلًا من تطبيق اختيار واحد على جميع الحالات.
المستويات الثلاثة هي التوقيع الإلكتروني، والتوقيع عن بُعد، والتوقيع بالتوكن. ويُعد التوقيع الإلكتروني خيارًا للاتفاقيات اليومية، بينما يناسب التوقيع عن بُعد أو بالتوكن العقود الرسمية وعالية القيمة. تعامل مع التحقق من الحساب عبر eKYC بوصفه إضافة مستقلة يمكن طلبها مع أي مستوى، ووثّق هذه القرارات قبل تحويلها إلى حقول طلبات باستخدام مرجع الواجهة الكامل.
اجعل الإرسال نقطة اعتماد واضحة
تُقفل المستندات في وقع بمجرد إرسالها، لذا ينبغي أن يُجري تطبيقك مراجعات المحتوى والأطراف قبل هذه الخطوة. ومن المفيد أن تعرض شاشة المراجعة النهائية الملف المقصود، وترتيب الموقّعين، والمستوى المطلوب لكل منهم، حتى يعرف المستخدم بدقة ما الذي يوشك على إرساله.
خطّط أيضًا لما سيحدث إذا انقطع الاتصال وأصبح تطبيقك غير متأكد من نجاح الإرسال. قبل تنفيذ إعادة المحاولة تلقائيًا، تأكد من مرجع الواجهة من آلية الاستعلام عن الحالة ومعالجة الطلبات المكررة. فهذا يمنع تصميم التكامل على افتراضات غير موثقة بشأن إعادة المحاولة؛ ولا ينبغي اعتبار المثال التوضيحي وصفًا كاملًا لسلوك الواجهة عند الانقطاع أو فشل الطلب.
احتفظ بأدلة الإنجاز ضمن سجل المعاملة
صمّم سجل المعاملة في نظامك بحيث يربط الملف الموقّع بشهادة الإتمام وسياق العمل الذي أُنشئ من أجله المستند. فسجل التدقيق في وقع يوثّق الإجراءات من الإرسال حتى التوقيع النهائي، بما يساعد المراجعين على فهم ما حدث، بدلًا من الاعتماد على ملف محفوظ وحده.
وفّر أيضًا مسارًا واضحًا للتحقق لاحقًا؛ إذ يظهر رمز QR الخاص بصفحة التحقق العامة على الملف النهائي وشهادة الإتمام. ويمكن التحقق من أصالة المستند دون حساب، وتكشف مقارنة بصمة SHA-256 أي تغيير في الملف. احتفظ بالنسخة الأصلية التي نزّلتها دون تعديل، وميّز أي نسخة مشتقة تستخدمها للعرض أو المعالجة الداخلية.
حوّل متطلبات التكامل إلى قائمة تحقق فنية
قبل بدء التنفيذ، أعدّ وصفًا موجزًا لمصدر المستندات، وأدوار الموقّعين، وقواعد اختيار مستويات التوقيع، وموضع حفظ السجلات المكتملة داخل نظامك. وحدد البيانات الشخصية التي تحتاج إلى تمريرها إلى وقع، والأشخاص داخل مؤسستك الذين يحتاجون إلى الوصول إلى المستندات الناتجة.
استخدم هذا الوصف عند مراجعة المرجع الكامل للواجهة وتفاصيل الوصول، مع تأكيد طريقة المصادقة، والصيغ المقبولة، واستجابات الأخطاء، وآلية متابعة الحالة، وأي حدود استخدام منطبقة. هذه نقاط يلزم التحقق منها، وليست إمكانات تثبتها هذه الصفحة المختصرة. وينقل وقع البيانات عبر TLS 1.2 أو أحدث، لكن يظل من المهم مراجعة ضوابط التخزين والصلاحيات في تطبيقك بعد تنزيل المستندات.
REST API
ابدأ التكامل بطلب واحد.
أنشئ المستند، أضف الموقّعين، وتابع الأحداث من داخل تطبيقك.
POST /v1/documents
{
"name": "contract.pdf",
"signers": [
{ "email": "sara@example.com" }
]
}ابدأ أول رحلة توقيع اليوم.
أنشئ حسابك على تطبيق WQ3، أو تحدث معنا عن متطلبات مؤسستك.
أسئلة شائعة
هل يمكن استخدام المثال التوضيحي مباشرة في بيئة الإنتاج؟+
المثال للتوضيح فقط. استخدم المرجع الكامل المتاح لعملاء الواجهة لتأكيد الحقول المطلوبة وسلوك الطلبات قبل التنفيذ.
هل يجب أن يستخدم جميع الموقّعين المستوى نفسه؟+
لا. يمكن اختيار مستوى مختلف لكل موقّع في المستند نفسه، وفقًا لمتطلبات الاتفاقية.
هل يُعد eKYC مستوى توقيع رابعًا؟+
لا. هو إضافة للتحقق من هوية صاحب الحساب، ويمكن طلبها مع أي من مستويات التوقيع الثلاثة.
هل تدعم الواجهة إشعارات webhook؟+
لا تؤكد هذه الصفحة دعمها. تحقّق من آلية متابعة الحالة المدعومة عند مراجعة المرجع الكامل للواجهة.
هل يجعل استخدام الواجهة كل اتفاقية نافذة قانونًا تلقائيًا؟+
لا. يقر قانون التوقيع الإلكتروني المصري رقم 15 لسنة 2004 بالحجية القانونية عند استيفاء شروطه؛ لذا راجع متطلبات كل اتفاقية على حدة.