سطح التكامل — نظرة عامة للمكامِل
ثلاثة أشكال للربط: نقاط REST بمفتاح API لإنشاء الشيكات والاستعلام عن البنوك والنماذج، تكامل Microsoft Dynamics الذي يحضّر الشيك ويسلّم الطباعة لموظف، وبثّ لحظي عبر Pusher للإشعارات. كلها من شاشة «التكامل» ومفتاح تفعيل واحد.
آخر تحديث: 2026-09-21
في الصفحة دي
لمن هذا القسم؟
لمبرمج الطرف الثالث الذي يربط ERP أو نظام محاسبة أو Dynamics ببرنامج الشيكات، ولمسؤول النظام الذي يدير المفاتيح ويراقب النداءات. الصفحات التالية مرجع عقد (contract) لا دليل موظف: كل حقل بقاعدته الحرفية، وكل ردّ بمثاله، وكل خطأ بكوده.
الأشكال الثلاثة
| الشكل | ما يفعله | من يبدأ | المصادقة |
|---|---|---|---|
| REST بمفتاح API | تسجيل شيك طُبع خارجيًا كصف في الحركات · قوائم البنوك والنماذج · استقبال إحصاءات | نظامك | X-API-KEY |
| Microsoft Dynamics | تحضير شيك ثم تسليم رابط لموظف يطبعه من شاشة الطباعة، ثم callback بنتيجة الطباعة | Dynamics ثم موظف مسجَّل الدخول | مفتاح للتحضير + جلسة الموظف للطباعة |
| Pusher | بثّ لحظي لإشعارات التذكير والإجراءات إلى متصفح المستخدم | البرنامج | مفاتيح Pusher من الإعدادات |
شاشة «التكامل»
الإعدادات ← التكامل (بصلاحية إدارة التكامل، داخل كارت الإعدادات في فورم الدور) — ثمانية تبويبات: نظرة عامة (مفتاح التفعيل العام ومدّة الاحتفاظ بسجل تدقيق الـAPI) · مفاتيح API · الدليل العام (شرح داخل البرنامج) · Postman (تحميل المجموعة) · SAP · Oracle · Odoo · Microsoft Dynamics — وتبويبات الأنظمة الأربعة توثيق مضمَّن وكتلة .env نموذجية، لا شاشات إعدادات.
تنبيه
مفتاح التفعيل العام في «نظرة عامة» يحكم كل نقاط النهاية: معطَّل ⟹ كل نداء يردّ 503 {"error":"Integrations are currently disabled"} مهما كان المفتاح صحيحًا. التنصيبة الجديدة تأتي به مفعَّلًا؛ راجعه أول شيء عند أي 503.
الترويسات المشتركة
X-API-KEY: <المفتاح>
Content-Type: application/json # لطلبات POST
Accept: application/json # مهم — بدونه قد يعود HTML لصفحة خطأ
قبل أول نداء
- مفتاح التفعيل العام مفعَّل.
- مفتاح API مُنشأ ومنسوخ — راجع مفاتيح API.
- البنك والنموذج المستهدفان نشطان في البرنامج — راجع البنوك والنماذج.
- لعناوين IP المحظورة: البرنامج يردّ 403 بنصّ عادي قبل أي منطق مفتاح؛ راجع مسؤول النظام.
الحدود الحالية للعقد
يُذكر هنا ما يجب أن يعرفه المكامِل قبل البناء — لا تلميعًا:
- المفتاح يحمل شركة واحدة: كل ما يُنشأ به يُختم بشركته، والحمولة التي تحمل
company_idأو مرجعًا (حساب · دفتر · شريك) من شركة أخرى تُرفض 422. مفتاح بلا شركة معطَّل حتى تُعيَّن — راجع مفاتيح API. - لا OpenAPI؛ المجموعة Postman وحدها — راجع البداية السريعة.
- الإصدار الحالي 1.8.0؛ العقد يتغيّر مع الإصدارات، راجع ما الجديد.
صفحات القسم
مفاتيح API · البنوك والنماذج · إنشاء شيك مباشرة · Dynamics — التدفق · Dynamics — الحقول والنموذج · استقبال الإحصاءات · Pusher · سجل التدقيق والأمان · مرجع الأخطاء · البداية السريعة وPostman
هل أجابت هذه الصفحة عن سؤالك؟
شكرًا — رأيك يصلنا ويساعدنا نحسّن الدليل.
تعذّر الإرسال — حاول مرة أخرى بعد قليل.