REST API পর্যালোচনা

REST API পর্যালোচনা

প্ল্যাটফর্মটি /api/ এর অধীনে একটি ব্যাপক REST API প্রকাশ করে, যা আপনাকে কাস্টম স্টোরফ্রন্ট, মোবাইল অ্যাপ, তৃতীয় পক্ষের ইন্টিগ্রেশন এবং অটোমেশন স্ক্রিপ্ট তৈরি করতে দেয়।

প্রমাণীকরণ

API টোকেন-ভিত্তিক প্রমাণীকরণের জন্য Laravel Sanctum ব্যবহার করে।

একটি টোকেন প্রাপ্তি

POST /api/auth/login
Content-Type: application/json

{
  "email": "[email protected]",
  "password": "your-password"
}

প্রতিক্রিয়ায় একটি token ক্ষেত্র অন্তর্ভুক্ত থাকে। এটি পরবর্তী অনুরোধগুলিতে Bearer টোকেন হিসেবে পাস করুন:

Authorization: Bearer {your-token}

প্রতিক্রিয়া ফরম্যাট

সমস্ত প্রতিক্রিয়া একটি সঙ্গতিপূর্ণ এনভেলপ ব্যবহার করে:

{
  "status": true,
  "message": "পণ্য সফলভাবে পুনরুদ্ধার করা হয়েছে",
  "data": { ... }
}

ভ্যালিডেশন ত্রুটি HTTP 422 ফেরত দেয় একটি errors অবজেক্ট সহ।

সংস্করণ নির্ধারণ

API URL প্রিফিক্সের মাধ্যমে সংস্করণযুক্ত। বর্তমান স্থিতিশীল সংস্করণ হল /api/v1/। ভাঙা পরিবর্তন কেবল একটি নতুন সংস্করণে প্রবর্তিত হয়।

হার সীমাবদ্ধতা

API অনুরোধগুলি প্রতি প্রমাণীকৃত ব্যবহারকারীর জন্য 60 অনুরোধ প্রতি মিনিট হার সীমাবদ্ধ। এটি অতিক্রম করলে HTTP 429 ফেরত দেয় একটি Retry-After হেডার সহ।