5 نقاط نهاية
الزبناء
سجل زبنائكم النهائيين — الاسم والبريد الإلكتروني والهاتف — تعيد الاشتراكات استعماله: إلى بريد الزبون الإلكتروني تُرسَل روابط كل استحقاق.
عناوين النقاط وأوصافها تأتي من عقد OpenAPI، بالإنجليزية — فلا يمكن أن تحيد عن الواجهة.
تُنشئون مفتاح الاختبار من البوابة بمجرد تفعيل حسابكم.
بكلمات بسيطة
دليل زبنائكم، ببيانات الاتصال التي تُرسَل إليها روابط الدفع.
متى تستعملونها
حين تريدون التعرف على زبون من أداء إلى آخر: الاشتراكات، أو مجرد سجل لكل زبون.
كيف تدمجونها
- 1أنشئوا الزبون مرة واحدة، ببريده الإلكتروني، واحتفظوا بمعرّفه من جهتكم.
- 2اربطوا به اشتراكاته: يُرسَل كل استحقاق إلى هذا العنوان.
- 3حدّثوا بياناته حين تتغير: تتبعها الروابط الموالية.
- 4احذفوا الزبون حين لا يبقى له اشتراك نشط: فهي بياناته، لا بياناتكم.
- GET
/v1/clients/{id}استرجاع زبون - PUT
/v1/clients/{id}تحديث زبون - DELETE
/v1/clients/{id}حذف زبون - GET
/v1/clientsعرض الزبناء - POST
/v1/clientsإنشاء زبون
استرجاع زبون
يجلب زبوناً واحداً بواسطة UUID الخاص به.
| الحقل | النوع | الموضع | مطلوب | الوصف |
|---|---|---|---|---|
id | string (uuid) | path | مطلوب | UUID الخاص بالزبون. |
تحديث زبون
يحدّث اسم الزبون و/أو بريده الإلكتروني و/أو هاتفه.
المخطط · UpdateClientRequest
| الحقل | النوع | الموضع | مطلوب | الوصف |
|---|---|---|---|---|
id | string (uuid) | path | مطلوب | |
name | string | body | اختياري | الاسم الكامل للزبون. اختياري؛ لا يُطبَّق إلا عند وجوده. |
email | string | body | اختياري | عنوان البريد الإلكتروني للزبون. اختياري؛ يُطبَّق فقط عند وجوده. |
phone | string | body | اختياري | رقم هاتف الزبون. اختياري؛ يُطبَّق فقط عند وجوده. |
حذف زبون
يحذف زبوناً. يُرجع 204 No Content. يفشل إذا كان الزبون لا يزال يملك اشتراكات نشطة.
| الحقل | النوع | الموضع | مطلوب | الوصف |
|---|---|---|---|---|
id | string (uuid) | path | مطلوب |
عرض الزبناء
يُرجع الزبناء المحفوظين في الحساب على شكل Page مقسّمة إلى صفحات.
| الحقل | النوع | الموضع | مطلوب | الوصف |
|---|---|---|---|---|
origin | enum | query | اختياري | التصفية حسب مصدر الإنشاء (API أو DASHBOARD).القيم APIDASHBOARD |
pageable | Pageable | query | مطلوب |
إنشاء زبون
يُنشئ سجل زبون قابلًا لإعادة الاستخدام لهذا الحساب.
المخطط · CreateClientRequest
| الحقل | النوع | الموضع | مطلوب | الوصف |
|---|---|---|---|---|
name | string | body | مطلوب | الاسم الكامل للزبون. |
email | string | body | اختياري | البريد الإلكتروني للزبون، اختياري. |
phone | string | body | اختياري | هاتف الزبون، اختياري (بصيغة E.164). |
أجروا أول نداء في وضع الاختبار
أنشئوا حسابكم، وأنشئوا مفتاح الاختبار من البوابة، وأرسلوا أول طلب اليوم — أو تحدّثوا إلى مختص دمج.
- مجاني ودون التزام
- وضع الاختبار منذ التسجيل
- لا موافقة تنتظرونها