Docs
शुरुआत करें
साइन-अप से आपके पहले लाइव डेटा तक, कुछ ही मिनटों में। आप अपनी API key के साथ एक वेब पता या सर्च टर्म भेजते हैं, और डेटा JSON में वापस पाते हैं। फिर त्रुटियों, लिमिट और caching पर एक छोटी नज़र।
तीन स्टेप
- 1
अपना अकाउंट बनाएँ
अपना ई-मेल दर्ज करें, हमारे भेजे लिंक से उसे कन्फ़र्म करें और पासवर्ड सेट करें। फ़्री में साइन अप करें
- 2
अपनी API key कॉपी करें
आपकी पहली विज़िट पर डैशबोर्ड “default” नाम की एक key बनाता है और उसे एक बार दिखाता है। उसे कॉपी करें और सुरक्षित रखें।
- 3
अपनी पहली रिक्वेस्ट भेजें
डैशबोर्ड quickstart में आज़माएँ दबाएँ, या नीचे दी गई रिक्वेस्ट अपनी key के साथ चलाएँ।
आपकी API key
हर रिक्वेस्ट के साथ अपनी key x-api-key header में भेजें। Keys ds_ से शुरू होती हैं। हम हर key का सिर्फ़ एक fingerprint सेव करते हैं, इसलिए वह पूरी सिर्फ़ एक बार, बनाते समय दिखती है। इसे secret manager में रखें, कभी भी ब्राउज़र में चलने वाले कोड में नहीं। आप API keys में और keys बना सकते हैं और पुरानी keys रद्द कर सकते हैं।
x-api-key: ds_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxBase URL: https://api.everydata.io।
आपकी पहली रिक्वेस्ट
Amazon पर “wireless headphones” सर्च करें। यह वही रिक्वेस्ट है जो डैशबोर्ड के आज़माएँ बटन से जाती है, जहाँ key बनते ही आपकी key पहले से भरी होती है। withCache=true 10 मिनट तक पुराने जवाब की अनुमति देता है, जिससे यह तेज़ हो जाता है।
curl "https://api.everydata.io/amz/amazon-search-by-keyword-asin?domainCode=com&keyword=wireless+headphones&page=1&withCache=true" \
-H "x-api-key: YOUR_API_KEY"क्या वापस आता है
हर सफल जवाब JSON होता है जो एक जैसे दो फ़ील्ड, responseStatus और responseMessage, से शुरू होता है, और उसके बाद उस endpoint का डेटा आता है। रिज़ल्ट के पेज में currentPage, nextPage और lastPage भी जुड़ते हैं।
{
"responseStatus": "PRODUCT_FOUND_RESPONSE",
"responseMessage": "Product successfully found!",
"domainCode": "com",
"keyword": "wireless headphones",
"foundProducts": [
"…"
],
"searchProductDetails": [
"…"
]
}त्रुटियाँ
त्रुटियाँ HTTP स्टेटस और पढ़ने योग्य संदेश के साथ एक छोटा JSON body लौटाती हैं। सिर्फ़ सफल जवाब और 404 (एक मान्य “not found”) आपके quota में गिने जाते हैं।
{
"statusCode": 400,
"statusMessage": "Bad Request - Missing or invalid parameter: keyword: Field required"
}| HTTP | मतलब | गिना गया |
|---|---|---|
| 200 | सफल। डेटा responseStatus और responseMessage के बाद आता है। | हाँ |
| 400 | कोई ज़रूरी पैरामीटर नहीं है या उसका फ़ॉर्मेट ग़लत है। | नहीं |
| 401 | API key नहीं है, ग़लत है या रद्द कर दी गई है। | नहीं |
| 403 | आपका मासिक quota (या fair-use लिमिट) ख़त्म हो गया है। | नहीं |
| 404 | पेज लोड हो गया, लेकिन आपके इनपुट के लिए कोई प्रोडक्ट या लिस्टिंग नहीं है। | हाँ |
| 429 | हर मिनट बहुत ज़्यादा रिक्वेस्ट। संदेश बताता है कि कितने सेकंड रुकना है। | नहीं |
| 502 | साइट ने इस कोशिश को ब्लॉक कर दिया। फिर से कोशिश करें। | नहीं |
| 503 | साइट लोड नहीं हो सकी। फिर से कोशिश करें। | नहीं |
लिमिट और quota
हर अकाउंट पर दो लिमिट लागू होती हैं: प्रति मिनट रिक्वेस्ट (प्लान के हिसाब से 10 से 750) और प्रति महीना रिक्वेस्ट। दोनों आपके अकाउंट के सभी प्लेटफ़ॉर्म और सभी keys में साझा होती हैं। प्रति मिनट बहुत ज़्यादा रिक्वेस्ट पर 429 मिलता है; मासिक quota ख़त्म होने पर आपको 403 मिलता है, जब तक वह अगली बिलिंग अवधि की शुरुआत में रीसेट न हो जाए।
जो रिक्वेस्ट साइट लोड न हो पाने (5xx) के कारण विफल होती हैं, वे नहीं गिनी जातीं। आपका मौजूदा उपयोग उपयोग पेज पर है; प्राइसिंग में हर प्लान की लिमिट दी गई हैं।
Caching
जवाब डिफ़ॉल्ट रूप से लाइव होते हैं। जहाँ ताज़गी से ज़्यादा स्पीड मायने रखती है, वहाँ कई endpoint withCache=true या cacheTtl (सेकंड) स्वीकार करते हैं और हाल की कॉपी से जवाब दे सकते हैं। cache किया गया जवाब भी एक रिक्वेस्ट गिना जाता है।
आगे: पूरा API रेफ़रेंस देखें।