8 نقاط نهاية
الزبناء
سجل زبنائكم النهائيين ووسائل الأداء المحفوظة لديهم، لإعادة استعمالها في الاشتراكات والأداءات المتكررة دون إعادة إدخال البيانات.
عناوين النقاط وأوصافها تأتي من عقد OpenAPI، بالإنجليزية — فلا يمكن أن تحيد عن الواجهة.
بكلمات بسيطة
دليل زبنائكم، وبطاقاتهم المحفوظة بموافقتهم.
متى تستعملونها
متى أردتم التعرف على الزبون من أداء إلى آخر: فوترة متكررة، أو بطاقة مسجلة تعيد الاشتراكات استعمالها، أو مجرد سجل لكل زبون.
كيف تدمجونها
- 1أنشئوا الزبون مرة واحدة، واحتفظوا بمعرّفه لديكم.
- 2اسردوا وسائل دفعه المحفوظة لتعرضوا عليه دفعة جديدة دون إعادة إدخال بطاقته.
- 3عيّنوا وسيلة افتراضية — وهي التي سيخصم منها الاشتراك.
- 4احذفوا وسيلة دفع فور طلب الزبون: فهي بياناته لا بياناتكم.
- GET
/v1/clients/{id}استرجاع زبون - PUT
/v1/clients/{id}تحديث زبون - DELETE
/v1/clients/{id}حذف زبون - POST
/v1/clients/{id}/payment-methods/{paymentMethodId}/defaultتعيين وسيلة الدفع الافتراضية لزبون - GET
/v1/clientsعرض الزبناء - POST
/v1/clientsإنشاء زبون - GET
/v1/clients/{id}/payment-methodsعرض وسائل الدفع المحفوظة لزبون - DELETE
/v1/clients/{id}/payment-methods/{paymentMethodId}حذف وسيلة دفع خاصة بزبون
استرجاع زبون
يجلب زبوناً واحداً بواسطة 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 | مطلوب |
تعيين وسيلة الدفع الافتراضية لزبون
يحدد إحدى وسائل الدفع الخاصة بالزبون كوسيلة افتراضية للاشتراكات الجديدة بالخصم التلقائي.
| الحقل | النوع | الموضع | مطلوب | الوصف |
|---|---|---|---|---|
id | string (uuid) | path | مطلوب | |
paymentMethodId | 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). |
عرض وسائل الدفع المحفوظة لزبون
تُرجع معرّفات محلية آمنة لوسيلة الدفع وبيانات وصفية مقنّعة للبطاقة. لا تُرجع أبدًا رموز البطاقة الخاصة بمزوّد الخدمة ولا CVV بنصه الصريح ولا CVV المشفّر.
| الحقل | النوع | الموضع | مطلوب | الوصف |
|---|---|---|---|---|
id | string (uuid) | path | مطلوب |
حذف وسيلة دفع خاصة بزبون
يحذف رمز المزوّد ويحذف نسخته المحلية حذفًا منطقيًا. تعود الاشتراكات التي تستخدمه إلى الدفع بحضور الزبون في محاولتها التالية.
| الحقل | النوع | الموضع | مطلوب | الوصف |
|---|---|---|---|---|
id | string (uuid) | path | مطلوب | |
paymentMethodId | string (uuid) | path | مطلوب |
سؤال حول الدمج؟
يجيب فريقنا التقني فرق الإدماج، من أول استدعاء في السندبوكس حتى الانتقال إلى الإنتاج.