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 हेडर लौटता है।