यहाँ से शुरू करें
प्रमाणीकरण
हर कॉल में आपकी API कुंजी अनुरोध की बॉडी में जाती है। कुंजी खाते की पहचान करती है, उसकी रेट लिमिट लागू करती है और हर कार्रवाई को उसी खाते के डेटा तक सीमित रखती है।
की कहाँ डालें
की को form-encoded रिक्वेस्ट बॉडी में key फ़ील्ड के रूप में पास करें। हेडर-आधारित auth सपोर्टेड नहीं है — v2 स्पेक मौजूदा reseller SDK के साथ कम्पैटिबिलिटी के लिए बॉडी पैरामीटर का इस्तेमाल करता है।
Content-Type: application/x-www-form-urlencoded
key=YOUR_API_KEY&action=servicesअनुरोध कैसे भेजें
फ़ॉर्म फ़ील्ड (application/x-www-form-urlencoded) या उन्हीं सपाट नामों वाले JSON ऑब्जेक्ट के साथ POST भेजें। बॉडी अधिकतम 32 KB की हो सकती है। अज्ञात पैरामीटर अनदेखे किए जाते हैं, और खाली मान को अनुपस्थित माना जाता है। कोई भी अन्य मेथड METHOD_NOT_ALLOWED के साथ अस्वीकार हो जाता है।
हर अनुरोध पर क्या जाँचा जाता है
कुंजी, खाता और API स्विच हर कॉल पर नए सिरे से जाँचे जाते हैं, इसलिए निलंबित खाता या रद्द की गई कुंजी तुरंत काम करना बंद कर देती है। खाता सक्रिय होना चाहिए और उसका ईमेल पता सत्यापित होना चाहिए।
- 401
INVALID_KEY
Invalid API keyकुंजी गायब है, गलत है या रद्द की जा चुकी है। पहले अनुरोध ठीक करें।
- 403
INACTIVE_ACCOUNT
Account suspendedखाता निलंबित है। पहले अनुरोध ठीक करें।
- 403
EMAIL_UNVERIFIED
Email verification requiredखाते का ईमेल पता अभी सत्यापित नहीं हुआ है। पहले अनुरोध ठीक करें।
- 503
API_DISABLED
The API is temporarily disabledAPI थोड़ी देर के लिए बंद है। Retry-After बताता है कि दोबारा कब कोशिश करें। दोबारा कोशिश से मदद मिल सकती है।
- 405
METHOD_NOT_ALLOWED
Use POSTअनुरोध POST नहीं था। पहले अनुरोध ठीक करें।
- 413
BODY_TOO_LARGE
Request body too largeअनुरोध की बॉडी बहुत बड़ी है। पहले अनुरोध ठीक करें।
key=YOUR_API_KEY&action=balance{
"error": "Invalid API key",
"error_code": "INVALID_KEY",
"retryable": false
}की बनाना और बदलना
कुंजियां /dashboard/api से बनाई और निरस्त की जाती हैं। raw कुंजी ठीक एक बार दिखाई जाती है। सर्वर एकतरफ़ा verifier और छोटा गैर-गोपनीय identifier रखता है, इसलिए raw वैल्यू बाद में वापस नहीं पाई जा सकती।
प्रति अकाउंट अधिकतम 5 सक्रिय की
। पुरानी की अलग-अलग रिवोक की जा सकती हैं।बिना डाउनटाइम बदलें।
एक replacement कुंजी बनाएं, अपना integration अपडेट करें, फिर पुरानी कुंजी निरस्त करें। नई requests में निरस्त कुंजियां अस्वीकार होती हैं।सक्रिय dashboard session आवश्यक है।
निर्माण के लिए authenticated, गैर-impersonated dashboard session चाहिए। यह अलग email-code या password prompt नहीं जोड़ता।
API की क्या नहीं कर सकती
v3 API कुंजी केवल दस्तावेज़ में दिए गए कार्यों तक सीमित है और लॉग इन किए गए डैशबोर्ड सत्र या दूसरे खाते के डेटा तक पहुँच नहीं दे सकती।
- बैलेंस निकालना या ट्रांसफ़र करना।
- अकाउंट का ईमेल, पासवर्ड, या 2FA सेटिंग्स बदलना।
- API के ज़रिए अन्य API कुंजियां बनाना या निरस्त करना।
- admin या मॉडरेशन एंडपॉइंट तक पहुँचना।
अपनी की सुरक्षित रखें
- केवल सर्वर-साइड। API की को कभी भी किसी browser बंडल, मोबाइल ऐप, या ऐसे किसी क्लाइंट में एम्बेड न करें जिसे कोई दूसरा पक्ष डीकम्पाइल कर सके।
- एनवायरनमेंट वेरिएबल इस्तेमाल करें। की को git में कमिट न करें।
.envफ़ाइलें.gitignoreमें होनी चाहिए। - शक होने पर निरस्त करें। अगर कोई कुंजी log, screenshot या shared chat में उजागर हो जाए, तो replacement बनाएं और उजागर कुंजी निरस्त करें।
- Polling घटाने के लिए webhooks इस्तेमाल करें जहाँ उपयोगी हो। Delivery retries के साथ best-effort है, इसलिए handlers को idempotent रखें और महत्वपूर्ण state को
action=statusसे reconcile करें।