الانتقال إلى المحتوى الرئيسي
توثيق الواجهة البرمجية

5 نقاط نهاية

الزبناء

سجل زبنائكم النهائيين — الاسم والبريد الإلكتروني والهاتف — تعيد الاشتراكات استعماله: إلى بريد الزبون الإلكتروني تُرسَل روابط كل استحقاق.

عناوين النقاط وأوصافها تأتي من عقد OpenAPI، بالإنجليزية — فلا يمكن أن تحيد عن الواجهة.

ابدؤوا في وضع الاختبار

تُنشئون مفتاح الاختبار من البوابة بمجرد تفعيل حسابكم.

بكلمات بسيطة

دليل زبنائكم، ببيانات الاتصال التي تُرسَل إليها روابط الدفع.

متى تستعملونها

حين تريدون التعرف على زبون من أداء إلى آخر: الاشتراكات، أو مجرد سجل لكل زبون.

كيف تدمجونها

  1. 1أنشئوا الزبون مرة واحدة، ببريده الإلكتروني، واحتفظوا بمعرّفه من جهتكم.
  2. 2اربطوا به اشتراكاته: يُرسَل كل استحقاق إلى هذا العنوان.
  3. 3حدّثوا بياناته حين تتغير: تتبعها الروابط الموالية.
  4. 4احذفوا الزبون حين لا يبقى له اشتراك نشط: فهي بياناته، لا بياناتكم.
GET

استرجاع زبون

يجلب زبوناً واحداً بواسطة UUID الخاص به.

الحقلالنوعالموضعمطلوبالوصف
idstring (uuid)pathمطلوبUUID الخاص بالزبون.
PUT

تحديث زبون

يحدّث اسم الزبون و/أو بريده الإلكتروني و/أو هاتفه.

المخطط · UpdateClientRequest

الحقلالنوعالموضعمطلوبالوصف
idstring (uuid)pathمطلوب
namestringbodyاختياريالاسم الكامل للزبون. اختياري؛ لا يُطبَّق إلا عند وجوده.
emailstringbodyاختياريعنوان البريد الإلكتروني للزبون. اختياري؛ يُطبَّق فقط عند وجوده.
phonestringbodyاختياريرقم هاتف الزبون. اختياري؛ يُطبَّق فقط عند وجوده.
DELETE204

حذف زبون

يحذف زبوناً. يُرجع 204 No Content. يفشل إذا كان الزبون لا يزال يملك اشتراكات نشطة.

الحقلالنوعالموضعمطلوبالوصف
idstring (uuid)pathمطلوب
GET

عرض الزبناء

يُرجع الزبناء المحفوظين في الحساب على شكل Page مقسّمة إلى صفحات.

الحقلالنوعالموضعمطلوبالوصف
originenumqueryاختياريالتصفية حسب مصدر الإنشاء (API أو DASHBOARD).القيم APIDASHBOARD
pageablePageablequeryمطلوب
POST201

إنشاء زبون

يُنشئ سجل زبون قابلًا لإعادة الاستخدام لهذا الحساب.

المخطط · CreateClientRequest

الحقلالنوعالموضعمطلوبالوصف
namestringbodyمطلوبالاسم الكامل للزبون.
emailstringbodyاختياريالبريد الإلكتروني للزبون، اختياري.
phonestringbodyاختياريهاتف الزبون، اختياري (بصيغة E.164).

تحدّثوا إلى مختص دمج

أجروا أول نداء في وضع الاختبار

أنشئوا حسابكم، وأنشئوا مفتاح الاختبار من البوابة، وأرسلوا أول طلب اليوم — أو تحدّثوا إلى مختص دمج.

  • مجاني ودون التزام
  • وضع الاختبار منذ التسجيل
  • لا موافقة تنتظرونها