کلید کا دائرہ
پروجیکٹ کی پابندی
پروجیکٹ (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 کے ساتھ انکار کرتا ہے۔
پابندیوں کا امتزاج
پروجیکٹ اور دائرے کی پابندیاں ایک ساتھ کام کرتی ہیں۔ مثال کے طور پر، اگر کلید انوائس کے میتھڈز تک محدود ہے اور کسی مخصوص پروجیکٹ سے جڑی ہے، تو:
- صرف انوائس کے میتھڈز دستیاب ہیں
- ڈیٹا صرف مخصوص پروجیکٹ تک فلٹر ہوتا ہے
- ادائیگیوں یا اعداد و شمار کی درخواستیں رد ہو جاتی ہیں
- دوسرے پروجیکٹس کے ڈیٹا کی درخواستیں رد ہو جاتی ہیں