مرجع API

كل مسار في واجهة API لشركاء أنيس، مُولَّد من العقد الذي تنشره البوابة. تذكر كل صفحة الغرض من المسار، والصلاحية التي يحتاجها، وكيف يُوقَّع، والحقول التي يأخذها ويُرجعها، وكل رفض قد يُرجعه.

تطبيقك

GETقراءة ملفّك
/v1/profile
profile:read
POSTتعليق تطبيقك
/v1/application/suspend
لا شيء
POSTإلغاء مفتاح للتطبيق
/v1/keys/{keyId}/revoke
لا شيء
GETقائمة العناوين المسموح بها
/v1/application/networks
لا شيء
POSTالسماح بعنوان إضافي
/v1/application/networks
لا شيء
POSTإزالة عنوان أضفته
/v1/application/networks/remove
لا شيء

المحافظ

GETقائمة المحافظ
/v1/wallets
wallets:read
GETقراءة محفظة
/v1/wallets/{walletId}
wallets:read

الكتالوج

GETقائمة فئات الكتالوج
/v1/wallets/{walletId}/catalog/categories
catalogue:read
GETقائمة الفئات الفرعية لفئة
/v1/wallets/{walletId}/catalog/categories/{categoryId}/subcategories
catalogue:read
GETقراءة فئة فرعية
/v1/wallets/{walletId}/catalog/subcategories/{subcategoryId}
catalogue:read
GETقائمة البطاقات المعروضة للبيع
/v1/wallets/{walletId}/catalog/subcategories/{subcategoryId}/cards
catalogue:read
GETقراءة بطاقة من الكتالوج
/v1/wallets/{walletId}/catalog/cards/{cardId}
catalogue:read

طلبات الشراء

POSTتقديم طلب شراء
/v1/wallets/{walletId}/orders
orders:create
GETقراءة طلب شراء
/v1/orders/{operationId}
orders:read

البطاقات المملوكة

GETقائمة البطاقات المملوكة
/v1/wallets/{walletId}/owned-cards
cards:read
GETقراءة بطاقة مملوكة
/v1/wallets/{walletId}/owned-cards/{soldCardId}
cards:read
POSTكشف بطاقة
/v1/wallets/{walletId}/owned-cards/{soldCardId}/reveal
cards:reveal
POSTكشف فاتورة
/v1/wallets/{walletId}/invoices/{invoiceId}/owned-cards/reveal
cards:reveal

التشخيص

POSTفحص توقيعك
/v1/diagnostics/signature
diagnostics:use

تسجيل المفتاح

GETقراءة دعوة
/v1/enrollments/{invitationId}
لا شيء
POSTإرسال مفتاح عام
/v1/enrollments/{invitationId}/keys
لا شيء
POSTإثبات حيازة المفتاح
/v1/enrollments/{invitationId}/proof
لا شيء
GETقراءة حالة التسجيل
/v1/enrollments/{invitationId}/status
لا شيء

مفاتيح التوقيع لدى أنيس

GETمفاتيح التوقيع العامة لدى أنيس
/.well-known/partner-signing-keys.json
لا شيء

شحن العدادات

GETعرض باقات شحن العداد
/v1/wallets/{walletId}/meter-packages
meter_charges:read
GETعرض عمليات شحن العدادات الخاصة بي
/v1/wallets/{walletId}/meter-charges
meter_charges:read
POSTشحن عداد
/v1/wallets/{walletId}/meter-charges
meter_charges:create
GETقراءة عملية شحن
/v1/meter-charges/{operationId}
meter_charges:read

الشحن المباشر

GETعرض الشحن المباشر
/v1/wallets/{walletId}/direct-recharge-products
direct_recharges:read
GETقراءة منتج الشحن المباشر
/v1/wallets/{walletId}/direct-recharge-products/{productId}
direct_recharges:read
GETالبحث عن مواقع المستلم
/v1/wallets/{walletId}/direct-recharge-products/{productId}/locations
direct_recharges:read
GETحساب تكلفة الشحن المباشر
/v1/wallets/{walletId}/direct-recharge-products/{productId}/quote
direct_recharges:read
GETعرض عمليات الشحن المباشر الخاصة بي
/v1/wallets/{walletId}/direct-recharges
direct_recharges:read
POSTطلب الشحن المباشر
/v1/wallets/{walletId}/direct-recharges
direct_recharges:create
GETمتابعة عملية شحن مباشر مطلوبة
/v1/direct-recharges/{operationId}
direct_recharges:read
PATCHتصحيح بيانات المستلم
/v1/direct-recharges/{operationId}/recipient
direct_recharges:create

إشعارات Webhook

GETقراءة عنوان الإشعارات
/v1/webhook-endpoint
لا شيء
PUTتسجيل عنوان الإشعارات
/v1/webhook-endpoint
لا شيء
POSTاختبار استقبال الإشعارات
/v1/webhook-endpoint/test
لا شيء
GETعرض تسليم الإشعارات
/v1/webhook-events
لا شيء
POSTإعادة إرسال إشعار
/v1/webhook-events/{eventId}/redeliver
لا شيء