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

نطاق المفتاح

قيد المشروع​

يحصر حقل المشروع (Project) مفتاح API في مشروع معيّن:

  • أي (Any) — يصل المفتاح إلى كل مشاريع الحساب
  • مشروع معيّن — يعمل المفتاح مع بيانات المشروع المحدد فقط

يتصرف القيد بشكل مختلف حسب الطريقة. في طرق القوائم يعمل كمرشِّح: تنجح الاستجابة لكنها لا تحتوي إلا بيانات المشروع. وفي الطرق التي تخاطب فاتورة أو محفظة بعينها، يرفض الخادم طلب كائن من مشروع آخر بالرد Restricted project.

الطريقةمفتاح مقيَّد بمشروع
billing/balancesبيانات على مستوى الحساب؛ لا ينطبق القيد
billing/historyعمليات المشروع إضافة إلى العمليات على مستوى الحساب — الإيداعات والمكافآت
billing/tariffsالتعرفة والدوران لمشروع المفتاح فقط
invoices/listالنتائج لمشروع المفتاح فقط
payments/listالنتائج لمشروع المفتاح فقط
statistics/invoicesتُحسب لمشروع المفتاح فقط
statistics/paymentsتُحسب على فواتير مشروع المفتاح فقط
invoices/createيجب أن يطابق projectId في الطلب مشروعَ المفتاح
invoices/cancelفاتورة مشروع آخر غير قابلة للوصول
invoices/bindPaymentفاتورة مشروع آخر غير قابلة للوصول

قيد النطاق​

يحدد النطاق طرق API التي يستطيع المفتاح استخدامها. وهو حقل إلزامي متعدد الاختيار.

يرفض الخادم استدعاء طريقة خارج نطاق المفتاح بالرد Restricted scope.

اجتماع القيود​

يعمل قيدا المشروع والنطاق معًا. مثلًا، إذا كان المفتاح محصورًا في طرق الفواتير ومربوطًا بمشروع معيّن:

  • لا تتاح إلا طرق الفواتير
  • لا تشمل البيانات إلا المشروع المحدد
  • يرفض الخادم طلبات الدفعات والإحصاءات
  • يرفض الخادم طلبات بيانات المشاريع الأخرى