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

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

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

تتم جميع نقاط النهاية باسم المستخدم المصرح له - الاشتراك دائمًا مرتبط بالرمز المميز الذي تم استخدامه في الطلب.

إنشاء اشتراك

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

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

  • stripe، midtrans - يتم إنشاء سجل للاشتراك ويتم إرجاع رابط للدفع. يصبح الاشتراك نشطًا بعد الخصم الناجح من قبل المزود.
  • custom - يتم إنشاء الاشتراك ويعتبر نشطًا على الفور. لا يتم إرجاع رابط للدفع، ويتم تسجيل الدفع يدويًا من قبل المسؤول عبر بطاقة المستخدم.

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

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

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

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

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

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

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

يعتبر الاشتراك نشطًا إذا:

  • تم إنشاؤه بنجاح.
  • لم تنتهِ فترته الحالية بعد.
  • لم يتم إلغاؤه (canceled).

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