API
توثیقِ اعتماد
ورک اسپیس کی کے ساتھ Mandavo API سے توثیق کریں، اور اس سے محدود دائرہ کار کی ایجنٹ اسناد تیار کریں۔
ورک اسپیس کیز
انتظامی کالز — شناختیں بنانا، پالیسی لکھنا، اسناد جاری کرنا — ورک اسپیس کی کے ساتھ توثیق ہوتی ہیں۔ سیٹنگز میں ایک بنائیں اور اسے Authorization ہیڈر میں بیئرر ٹوکن کے طور پر بھیجیں۔
ورک اسپیس کیز صرف آپ کے بیک اینڈ کے لیے ہیں۔ وہ کبھی کسی ایجنٹ تک نہیں جاتیں؛ ایجنٹس آپ کے ان کے لیے تیار کردہ مختصر مدتی اسناد کے ساتھ عمل کرتے ہیں۔
بیس URL اور ورژننگ
تمام درخواستیں https://api.mandavo.com پر جاتی ہیں اور /v1 سے شروع ہونے والے پاتھ پریفکس سے ورژن شدہ ہیں۔ توڑنے والی تبدیلیاں ایک نئے پریفکس کے تحت شپ ہوتی ہیں؛ اضافی تبدیلیاں نہیں۔
درخواستیں اور جوابات JSON ہیں۔ کسی بھی باڈی والی درخواست پر Content-Type: application/json بھیجیں۔
ایجنٹ اسناد
کسی ایجنٹ کو عمل کرنے دینے کے لیے، اجراء انجن کے ذریعے ورک اسپیس کی کو محدود دائرہ کار کی سند سے تبدیل کریں، پھر صرف وہی مختصر مدتی ٹوکن ایجنٹ کو دیں۔ ٹوکن شناخت، دائرہ کار، اور ایک میعاد رکھتا ہے۔
ایجنٹ اسناد کو واحد کام اور میموری میں سمجھیں۔ انہیں محفوظ نہ کریں؛ اگلے کام کے لیے نیا مانگیں۔
خرابیاں
API معیاری HTTP اسٹیٹس کوڈز استعمال کرتا ہے۔ 401 کا مطلب ہے کی غائب یا غلط ہے، 403 کا مطلب ہے عمل کالر کے دائرہ کار سے باہر ہے یا پالیسی کے ذریعے مسترد ہے، اور 429 کا مطلب ہے آپ کی شرح محدود ہے۔ ایرر باڈیز میں ایک مشین کے پڑھنے کے قابل کوڈ اور ایک انسان کے پڑھنے کے قابل پیغام شامل ہوتا ہے۔