# API

<figure><img src="/files/88b3b82d98d26a9a5978ec079af9d2d990b84f1c" alt=""><figcaption></figcaption></figure>

***

## **API संदर्भ**

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

***

## एंडपॉइंट

सभी API अनुरोध निम्नलिखित बेस URL पर भेजे जाने चाहिए:\ <mark style="color:नीला;"><https://rest.boxhero-app.com></mark>

## **प्रमाणीकरण**

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

```
Authorization: Bearer {API_TOKEN}
```

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

1. Desktop (Web) पर अपने BoxHero खाते में लॉग इन करें।
2. पर जाएँ <mark style="color:नीला;">`सेटिंग्स`</mark> > <mark style="color:नीला;">`Integrations`</mark>.
3. एक नया API टोकन जनरेट करें।

## **अनुरोध करना**

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

```bash
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 रेंज: सर्वर-साइड त्रुटि।

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

```json
{
  "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*"।

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

<table><thead><tr><th width="252">प्रकार</th><th>विवरण</th></tr></thead><tbody><tr><td>/errors/not-found</td><td>अनुरोधित संसाधन नहीं मिला (जैसे, किसी विशिष्ट ID वाला आइटम मौजूद नहीं है)।</td></tr><tr><td>/errors/invalid-request</td><td>अनुरोध में अमान्य पैरामीटर।</td></tr><tr><td>/errors/invalid-team-mode</td><td>अनुरोधित क्वेरी वर्तमान टीम मोड में संसाधित नहीं की जा सकती (जैसे, <em>location</em> लुकअप API का उपयोग करना <em>बेसिक मोड</em>).</td></tr><tr><td>/errors/tokens/required</td><td>API टोकन अनुपस्थित है।</td></tr><tr><td>/errors/tokens/invalid</td><td>अमान्य API टोकन (जैसे, API टोकन की अवधि समाप्त हो गई है)।</td></tr><tr><td>/errors/too-many-requests</td><td>रेट लिमिट पार हो गई।</td></tr><tr><td>/errors/unhandled</td><td>अनसुलझी सर्वर-साइड त्रुटि।</td></tr><tr><td>/errors/core/usage-limit-exceeded</td><td>उपयोग सीमा तक पहुँच गए। प्लान अपग्रेड आवश्यक है।</td></tr></tbody></table>

## पृष्ठीकरण

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

{% hint style="info" %}
यह निर्धारित करने के लिए कि पृष्ठीकरण आवश्यक है या नहीं, API दस्तावेज़ीकरण में एंडपॉइंट के अनुरोध बॉडी में पृष्ठीकरण-संबंधी पैरामीटर मौजूद हैं या नहीं, यह जाँचें।
{% endhint %}

#### **पृष्ठीकरण पैरामीटर**

* `has_more` : एक बूलियन जो दर्शाता है कि क्या वर्तमान पृष्ठ से आगे और डेटा मौजूद है।
* `cursor` : अगला पृष्ठ पुनः प्राप्त करने के लिए कर्सर मान प्रदान करता है।

#### **अगला पृष्ठ प्राप्त करना**

* जाँचें कि `has_more` है `true`. इसका अर्थ है कि एक और पृष्ठ उपलब्ध है।
* यदि `true`तो, शामिल करते हुए एक और अनुरोध भेजें `cursor={प्राप्त कर्सर मान}` पैरामीटरों में। इससे अगला डेटा वापस मिलेगा।
* दोहराएँ जब तक `has_more` है `false` तक पूर्ण सूची प्राप्त करने के लिए।

***

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

यदि आपको समस्याएँ आती हैं या अतिरिक्त API कार्यक्षमता की आवश्यकता है, तो कृपया हमारी [सपोर्ट टीम](https://docs-en.boxhero.io/etc/contact)से संपर्क करें। API सुधारों और नई सुविधा अनुरोधों के लिए हम आपकी प्रतिक्रिया का स्वागत करते हैं।

{% embed url="<https://www.boxhero.io/en/blog/boxhero-open-api-integrate-inventory-data>" %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://www.boxhero.io/docs/documentation/hi/integrations/open-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.