API

BoxHero का API डेवलपर्स को हमारे इन्वेंट्री प्रबंधन क्षमताओं को बाहरी अनुप्रयोगों के साथ एकीकृत करने की सुविधा देता है ताकि डेटा प्राप्ति और इंटरैक्शन कुशल हो सके।

BoxHero’s API: A Simple Way to Integrate Your Inventory DataBoxHero Blog

---

API संदर्भ

विस्तृत एंडपॉइंट दस्तावेज़ीकरण के लिए, कृपया देखें: https://rest.boxhero-app.com/docs/api

---

एंडपॉइंट

सभी API अनुरोध निम्नलिखित बेस URL पर भेजे जाने चाहिए: https://rest.boxhero-app.com

प्रमाणीकरण

सभी API अनुरोधों में एक Authorization हेडर और एक Bearer टोकन:

Authorization: Bearer {API_TOKEN}

API टोकन प्राप्त करने के लिए:

1. Desktop (Web) पर अपने BoxHero खाते में लॉग इन करें।

2. पर जाएँ सेटिंग्स > एकीकरण.

3. एक नया API टोकन जनरेट करें।

अनुरोध करना

यहाँ उत्पादों को पुनः प्राप्त करने के लिए एक नमूना API अनुरोध है।

curl -X 'GET' \
  'https://rest.boxhero-app.com/v1/items?location_ids=12345&location_ids=34567&limit=100' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer test-api-token-123'

रेट सीमाएँ

सिस्टम की स्थिरता सुनिश्चित करने के लिए, हम निम्नलिखित रेट सीमाएँ लागू करते हैं:

• प्रत्येक एंडपॉइंट के लिए प्रति सेकंड 5 क्वेरी।

एक बार जब आप रेट-सीमित हो जाते हैं, तो आपको निम्नलिखित के साथ एक त्रुटि संदेश दिखाई देगा:

• X-Ratelimit-Limit - प्रति मिनट अधिकतम क्वेरियाँ

• X-Ratelimit-Remaining - शेष क्वेरियाँ

• X-Ratelimit-Reset - क्वेरी गिनती रीसेट होने तक शेष समय (सेकंड में)

---

प्रतिक्रियाएँ

सफलता

HTTP स्थिति कोड 200 रेंज में होने वाली प्रतिक्रियाएँ सफल API प्रसंस्करण को दर्शाती हैं।

त्रुटि

400 या 500 रेंज में स्थिति कोड API अनुरोध विफलताओं को दर्शाते हैं:

• 400 रेंज: अनुरोध के साथ प्रदान की गई जानकारी से उत्पन्न क्लाइंट-साइड त्रुटि (जैसे, आवश्यक पैरामीटर गायब होना)।

• 500 रेंज: सर्वर-साइड त्रुटि।

उदाहरण त्रुटि प्रतिक्रिया:

{
  "id": "ex_ku3gij67k9xzc8ef6r5esyu5",
  "type": "/errors/tokens/invalid",
  "title": "प्रमाणीकरण टोकन अमान्य है। कृपया एक मान्य टोकन प्रदान करें।",
  "correlation_id": "rq_z4g7dh55ykol7v2cx6homkpd",
  "given": "invalid-token-123"
}

• id : त्रुटि की पहचान के लिए एक अद्वितीय ID।

• type : URL के रूप में एक कोड जो त्रुटि के प्रकार की पहचान करता है।

• title : त्रुटि की सामग्री को मानव-पठनीय रूप में प्रदान करें।

• correlation_id : त्रुटि से संबंधित अनुरोध के ID की ओर संकेत करता है।

• others : अतिरिक्त जानकारी प्रदान करने के लिए अतिरिक्त फ़ील्ड शामिल किए जा सकते हैं, जैसे उदाहरण में "given"।

सामान्य त्रुटि प्रकार

प्रकार	विवरण
/errors/not-found	अनुरोधित संसाधन नहीं मिला (जैसे, किसी विशिष्ट ID वाला आइटम मौजूद नहीं है)।
/errors/invalid-request	अनुरोध में अमान्य पैरामीटर।
/errors/invalid-team-mode	अनुरोधित क्वेरी को वर्तमान टीम मोड में संसाधित नहीं किया जा सकता (जैसे, उपयोग करना स्थान lookup API in Basic Mode).
/errors/tokens/required	API टोकन गायब है।
/errors/tokens/invalid	अमान्य API टोकन (जैसे, API टोकन समाप्त हो गया है)।
/errors/too-many-requests	रेट सीमा पार कर ली गई।
/errors/unhandled	अनसुलझी सर्वर-साइड त्रुटि।
/errors/core/usage-limit-exceeded	उपयोग सीमा तक पहुँच गए। योजना उन्नयन आवश्यक है।

पेजिनेशन

बड़े डेटासेट लौटाने वाले एंडपॉइंट्स (जैसे, आइटम सूचियाँ, लेनदेन सूचियाँ) के लिए, सूची दृश्य API पेजिनेशन के माध्यम से एकल अनुरोध में लौटाए जाने वाले आइटमों की संख्या सीमित करता है। हम कर्सर-आधारित पेजिनेशन का उपयोग करते हैं:

यह निर्धारित करने के लिए कि क्या पेजिनेशन आवश्यक है, API दस्तावेज़ीकरण में एंडपॉइंट के अनुरोध बॉडी में पेजिनेशन-संबंधी पैरामीटर मौजूद हैं या नहीं, जाँचें।

पेजिनेशन पैरामीटर

• has_more : एक बूलियन जो दर्शाता है कि क्या वर्तमान पृष्ठ के बाद और डेटा मौजूद है।

• cursor : अगला पृष्ठ पुनः प्राप्त करने के लिए कर्सर मान प्रदान करता है।

अगला पृष्ठ पुनः प्राप्त करना

• जाँचें कि has_more है true. इसका अर्थ है कि एक और पृष्ठ उपलब्ध है।

• यदि trueतो एक और अनुरोध भेजें जिसमें शामिल हो cursor={received cursor value} पैरामीटर में। यह बाद का डेटा लौटाएगा।

• दोहराएँ जब तक has_more है false ताकि पूरी सूची प्राप्त हो सके।

---

सहायता और प्रतिक्रिया

यदि आपको समस्याएँ आती हैं या अतिरिक्त API कार्यक्षमता की आवश्यकता है, तो कृपया हमारी सहायता टीमसे संपर्क करें। हम API सुधारों और नई सुविधा अनुरोधों के लिए आपकी प्रतिक्रिया का स्वागत करते हैं।