शुरुआत करें

त्रुटियाँ

कुछ गलत होने पर API संबंधित HTTP स्टेटस और एक बॉडी लौटाता है, जिसमें error के अंदर code और message होते हैं।

अपने प्रोग्राम में code का उपयोग करें। message अंग्रेज़ी में लिखा टेक्स्ट है, जो डीबग करने वाले की मदद के लिए है और बदल सकता है।

त्रुटि का फ़ॉर्मेट404

{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}

बिना कुंजी401

{
  "error": {
    "code": "missing_api_key",
    "message": "Send your API key in the X-API-Key header or as Authorization: Bearer <key>."
  }
}

त्रुटि कोड

स्थिति	कोड	कब होता है
400	`key_in_query`	कुंजी URL में भेजी गई थी (पैरामीटर `api_key`, `apikey`, `key` या `token`)। उसे हेडर में भेजें और नई कुंजी जनरेट करें, क्योंकि पुरानी कुंजी लॉग में दर्ज हो चुकी हो सकती है।
400	`invalid_parameter`	किसी पैरामीटर का मान अमान्य है, जैसे `per_page` अधिकतम सीमा से ज़्यादा।
401	`missing_api_key`	अनुरोध में कुंजी नहीं थी।
401	`invalid_api_key`	कुंजी मौजूद नहीं है, निरस्त कर दी गई है या उसका उपयोगकर्ता निष्क्रिय है।
404	`not_found`	एंडपॉइंट मौजूद नहीं है, या आइटम मौजूद नहीं है या ऐसे संगठन का है जिसे उपयोगकर्ता नहीं देख सकता।
404	`organization_not_found`	दिया गया `organization` ऐसा संगठन नहीं है जिसमें उपयोगकर्ता इस प्रकार के आइटम देख सकता हो।
405	`method_not_allowed`	API केवल `GET` (और `HEAD`) स्वीकार करता है।
429	`rate_limited`	अनुरोधों की सीमा पूरी हो गई है। `Retry-After` में दिए गए सेकंड तक रुकें।
500	`server_error`	आंतरिक त्रुटि। थोड़ी देर में फिर से प्रयास करें; अगर समस्या बनी रहे, तो सहायता टीम से संपर्क करें।

दोबारा कब प्रयास करें

वही अनुरोध दोबारा सिर्फ़ 429 (Retry-After तक रुककर) या 500 के बाद भेजें। बाकी त्रुटियों के लिए अनुरोध या कुंजी में सुधार करना ज़रूरी है।