API संदर्भ

बेस URL

सभी एंडपॉइंट एक ही, वर्ज़नयुक्त बेस पाथ के अंतर्गत उपलब्ध हैं। v1 स्थिर है और इसमें कोई ब्रेकिंग बदलाव नहीं होगा।

/api/v1

प्रमाणीकरण

अनुरोध साइन-इन के समय जारी किए गए एक अल्पकालिक एक्सेस token से प्रमाणित होते हैं, जो HTTP-only cookie के रूप में भेजा जाता है। समाप्त हो चुके token स्वचालित रूप से रीफ़्रेश किए जाते हैं।

रिस्पॉन्स फ़ॉर्मेट

हर रिस्पॉन्स एक ही एन्वेलप का उपयोग करता है। सफल रिस्पॉन्स में एक data पेलोड होता है (और सूचियों के लिए meta); त्रुटियों में एक स्थिर code और एक पठनीय संदेश होता है।

{
  "success": true,
  "message": "OK",
  "data": { },
  "meta": { "page": 1, "pageSize": 20, "total": 42 }
}

{
  "success": false,
  "code": "VALIDATION_ERROR",
  "message": "The request could not be processed."
}

परंपराएँ

• पेजिनेशन?page=1&pageSize=20
• फ़िल्टरिंग?filter[status]=active
• सॉर्टिंग?sort=createdAt:desc

सामान्य एंडपॉइंट

यह एक प्रतिनिधि उपसमूह है। पूर्ण, हमेशा अद्यतन संदर्भ सार्वजनिक API के साथ उपलब्ध होगा।