انتقل إلى المحتوى الرئيسي

واجهة برمجة التطبيقات للاشتراكات

يتعامل تطبيق العميل مع الاشتراكات عبر ثلاث نقاط نهاية: إنشاء اشتراك، وإلغاء اشتراك، والحصول على قائمة الاشتراكات النشطة للمستخدم الحالي.

تُنفَّذ جميع نقاط النهاية باسم المستخدم المصرَّح له، ويرتبط الاشتراك دائمًا بالرمز المميز الذي أُرسل به الطلب.

إنشاء اشتراك​

تنشئ اشتراكًا جديدًا للمستخدم الحالي على الرمز المحدد.

يختلف السلوك حسب نوع حساب الدفع المرتبط بالاشتراك في إعدادات الوحدة (يفتح في علامة تبويب جديدة):

  • stripe، midtrans: يُنشأ سجل للاشتراك ويُعاد رابط للدفع. يصبح الاشتراك نشطًا بعد أن ينجح المزوّد في تحصيل المبلغ.
  • custom: يُنشأ الاشتراك ويُعدّ نشطًا فورًا. لا يُعاد رابط للدفع، ويسجّل المسؤول الدفع يدويًا من بطاقة المستخدم (يفتح في علامة تبويب جديدة).

إلغاء الاشتراك​

تلغي الاشتراك النشط للمستخدم فورًا.

يختلف السلوك حسب نوع حساب الدفع:

  • stripe، midtrans: يُلغى الاشتراك عبر واجهة برمجة التطبيقات الخاصة بالمزوّد، فتتوقف عمليات التحصيل التلقائية وتتغير حالة الاشتراك إلى canceled.
  • custom: الإلغاء عبر واجهة برمجة التطبيقات غير متاح. لا يمكن إلغاء هذه الاشتراكات إلا من قِبل المسؤول عبر بطاقة المستخدم (يفتح في علامة تبويب جديدة).
معلومات

تُعيد محاولة إلغاء اشتراك custom عبر واجهة برمجة التطبيقات خطأً. هذا السلوك مقصود: يدير المسؤول الاشتراكات اليدوية لأن مدفوعاتها تتم خارج النظام.

الحصول على الاشتراكات النشطة​

تُعيد مصفوفة من رموز الاشتراكات النشطة للمستخدم الحالي.

يُعدّ الاشتراك نشطًا إذا:

  • أُنشئ بنجاح.
  • لم تنتهِ فترته الحالية بعد.
  • لم يُلغَ (canceled).

إذا انتهى الاشتراك أو أُلغي، يختفي رمزه من القائمة تلقائيًا. يمكنك استخدام نقطة النهاية هذه على العميل للتحقق من صلاحية الوصول إلى المحتوى: إذا كان رمز الاشتراك المطلوب موجودًا في المصفوفة، يُمنح الوصول.