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