مقدمة
CodFlow منصة تجارة بالدفع عند الاستلام صُممت للجزائر. يحصل التجار على لوحة تحكم، وواجهة متجر قابلة للقالب، وAPI REST مُعرّف الأنواع للطلبات والتوصيل والكتالوج والعملاء والمراجعات وإعدادات المتجر.
هذا الموقع هو المرجع التقني لتلك المنصة. تُولّد مرجع API وأنواع SDK من مستند OpenAPI الذي يقدّمه cod-server ومن الحزم المنشورة، لذا تطابق نقاط النهاية والأنواع الشيفرة التي تُنشر. ويُصان دليل SDK القوالب هنا.
كيف يُنظَّم هذا الموقع
- الأدلة تشرح المفاهيم المشتركة بين كل نقاط النهاية: المصادقة والأخطاء وWebhooks وخادم MCP.
- مرجع API يُولَّد من مستند OpenAPI المباشر. تتضمن كل عملية معاملاتها أو جسم طلبها ومخطط الاستجابة — ومتطلب أمان عندما يحدده المسار. ولكل عملية ساحة تجربة.
- مراجع SDK تُولَّد من تعريفات TypeScript المنشورة. يُنشر دليل SDK واجهة المتجر مع حزمته؛ أما دليل SDK القوالب فيُكتب ويُصان هنا.
ما يمكنك بناؤه
- قالب واجهة متجر بمحرك واجهة المتجر وعقد القوالب، يُنشر كحزمة npm عادية.
- أتمتة الطلبات والتوصيل التي تنشئ الطلبات وتسلّمها لشركة توصيل وتتفاعل مع أحداث الشحن.
- أدوات الكتالوج والعملاء للوحة إدارة أو أداة استيراد أو سير عمل الدعم.
- تكاملات وكلاء الذكاء الاصطناعي عبر خادم MCP المحمي بـ OAuth، بأدوات محدودة بصلاحيات المستخدم المسجّل.
معاينة محلية
يُولَّد مرجع API من مستند OpenAPI الذي يقدّمه cod-server. عند التشغيل محليًا، ابدأ الخادم بـ npm run dev داخل cod-server، ثم شغّل npm run generate داخل cod-docs بعد تغيير المسارات. يشير محدّد الخادم في مرجع API افتراضيًا إلى http://localhost:8787.