दस्तावेज़ देखें
API संदर्भ
असफल अनुरोध के कारण का पता लगाएं और यह तय करें कि क्या इसे ठीक करने, प्रतीक्षा करने या फिर जाने का फैसला किया जाए।
इस पेज पर
HTTP स्टेटस कोड
HTTP स्थिति के साथ शुरू करें, फिर विशिष्ट कारण के लिए त्रुटि कोड और संदेश पढ़ें।
| स्थिति | अर्थ | क्या करें |
|---|---|---|
| 400 | अमान्य अनुरोध | पुनः प्रयास करने से पहले स्रोत, आवश्यक फ़ील्ड, पैरामीटर प्रकार या प्रतिक्रिया हेडर को ठीक करें। |
| 401 | प्रमाणीकरण विफल रहा | चेक X-API-Key. एक समाप्त हो गया या रद्द कुंजी बदलें; उसी कुंजी को पुनः प्राप्त करने में मदद नहीं होगी। |
| 402 | अपर्याप्त क्रेडिट | खाता बैलेंस चेक करें। क्रेडिट जोड़ें या खाता मालिक को फिर से जमा करने से पहले पहुंच को हल करने दें। |
| 403 | प्रवेश इनकार | कुंजी के स्रोत अनुमतियों और खाते या सदस्यता की स्थिति की जांच करें। |
| 404 | नहीं मिला | URL, नौकरी ID और खाता चेक करें। अपने अनुमत खाते या स्रोतों के बाहर नौकरियां भी 404 वापस कर सकते हैं। |
| 406 | प्रतिक्रिया प्रकार स्वीकार्य नहीं है | Accept का प्रयोग करें: application/json या text/plain. X-Respond-With के साथ Markdown का चयन करें: मार्कडाउन। |
| 409 | परिणाम तैयार / संघर्ष नहीं | परिणामस्वरूप पढ़ने पर, मौजूदा नौकरी को तब तक मतदान करें जब तक यह पूरा नहीं हो जाता। अन्य समापन बिंदुओं के लिए, शरीर में वर्णित संघर्ष को हल करें। |
| 410 | परिणाम की समाप्ति | एक सहेजी गई प्रतिलिपि का उपयोग करें। परिणाम URL को पुनः प्राप्त करने से एक समाप्त परिणाम को बहाल नहीं किया जा सकता है। |
| 422 | अमान्य इनपुट / असफल नौकरी | रिपोर्ट किए गए क्षेत्रों को ठीक करें। परिणामस्वरूप पढ़ने के बाद, job.error का निरीक्षण करें: एक असफल नौकरी के पास कोई सफल परिणाम नहीं है। |
| 429 | सीमा तक पहुंच | Retry-After या retry_after के लिए प्रतीक्षा करें। अनुरोध दर को कम करें; एक पूर्ण लंबित कतार के लिए, मौजूदा नौकरियों के लिए finish पर प्रतीक्षा करें। |
| 500 / 502 / 503 / 504 | सेवा या अपस्ट्रीम विफलता | Retry, बाउंड बैकऑफ के साथ पढ़ता है। एक POST या प्रस्तुतीकरण टाइमआउट के लिए, जांचें कि क्या काम फिर से भेजने से पहले स्वीकार किया गया था। |
एक त्रुटि प्रतिक्रिया पढ़ें
API त्रुटियां JSON का उपयोग करती हैं, जिसमें शामिल हैं जब आप सादे पाठ का अनुरोध करते हैं। शरीर अंत बिंदु से भिन्न होता है। प्रस्तुत करते समय HTTP स्थिति और कोड पर शाखा; समस्या को समझाने के लिए संदेश या विस्तार का उपयोग करें।
क्वेरी त्रुटियों में आमतौर पर त्रुटि और संदेश शामिल होते हैं; कोड वैकल्पिक है। प्रमाणीकरण त्रुटियां error: true के बजाय success: false का उपयोग कर सकती हैं।
{
"error": true,
"code": "unsupported_representation",
"message": "X-Respond-With supports markdown. Omit the header for the original result fields."
}V2 समस्या उत्तर application/problem+json. का उपयोग करते हैं समर्थन के लिए requestId रखें। सत्यापन त्रुटियों में फ़ील्ड, कोड और संदेश के साथ fieldErrors भी शामिल हो सकता है।
{
"type": "https://api.flashdata.dev/problems/invalid_api_key",
"title": "Invalid API Key",
"status": 401,
"code": "invalid_api_key",
"requestId": "example-request-id",
"detail": "The API Key is invalid or unavailable."
}दृष्टि स्थिति, हेडर और शरीर
सभी तीनों को देखने के लिए curl --include का उपयोग करें। यह उदाहरण एक मुफ्त खाता पढ़ने के साथ अपनी कुंजी की जाँच करता है; यह एक क्वेरी प्रस्तुत नहीं करता है। पहले अपने पर्यावरण में FLASHDATA_API_KEY सेट करें।
curl --include --silent --show-error --max-time 20 \
'https://api.flashdata.dev/v2/api-access/identity' \
--header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
--header 'Accept: application/json'कब्ज़ा
एक बार दोहराया POST एक और बिलेबल क्वेरी बना सकते हैं। नेटवर्क टाइमआउट यह साबित नहीं करता कि पहला अनुरोध अस्वीकार कर दिया गया था। जितनी जल्दी हो सके नौकरी ID को सेव करें।
| स्थिति | अगली कार्रवाई |
|---|---|
| अवैध इनपुट, कुंजी, अनुमति या संतुलन | बंद करो। अनुरोध को ठीक करें या जवाब देने से पहले राज्य; इन त्रुटियों पर लूप न करें। |
| एक प्रतीक्षा संकेत के साथ 429 | ऑनर Retry-After (सेकेंड या HTTP तारीख), या JSON retry_after मान सेकंड में। यदि दोनों मौजूद हैं, तो लंबे समय तक देरी का उपयोग करें। |
| अनुरोध पढ़ें: 429 / अस्थायी 5xx / नेटवर्क त्रुटि | उसी GET को पुनः प्राप्त करें। एक प्रतीक्षा संकेत के बिना, जिटर के साथ बढ़ती देरी, अधिकतम प्रयास गिनती और एक समय सीमा का उपयोग करें। |
| POST टाइमआउट या अस्पष्ट 5xx | मौजूदा नौकरी ID रखें और इसकी स्थिति की जांच करें। यदि कोई ID प्राप्त नहीं किया गया था, तो फिर से जमा करने से पहले नौकरी के इतिहास का निरीक्षण करें। |
पृष्ठभूमि नौकरी की जाँच करें
HTTP 200 का मतलब है कि यह पोस्ट जारी किया गया है। job.status को यह जानने के लिए कि क्या कार्य सफल रहा है। अपने मौजूदा काम के लिए JOB_ID सेट करें; यह कमांड प्रतिस्थापन प्रस्तुत नहीं करता है।
| job.status | क्या करें |
|---|---|
| pending / processing | फिर प्रतीक्षा करें, फिर उसी नौकरी पर मतदान करें। परिणाम पूरा होने तक 409 लौटाता है। |
| completed | परिणाम को पुनर्प्राप्त और सहेजना। मूल JSON परिणाम एक 302 संग्रहण रीडायरेक्ट वापस लौटते हैं; स्वरूपित परिणाम सीधे एक शरीर लौटाते हैं। |
| failed | मतदान बंद करें और job.error का निरीक्षण करें। परिणाम समापन बिंदु एक असफल नौकरी के लिए कोड result_not_ready के साथ 422 लौटाता है। |
curl --fail-with-body --silent --show-error --max-time 30 \
"https://api.flashdata.dev/v2/jobs/${JOB_ID:?Set JOB_ID}" \
--header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
--header 'Accept: application/json'प्रतिक्रिया-format त्रुटियों
| स्थिति / कोड | फिक्स |
|---|---|
| 400 · unsupported_representation | X-Respond-With को मार्कडाउन में सेट करें, या हेडर को हटा दें। |
| 406 · not_acceptable | Accept को application/json या text/plain में सेट करें; एक charset निर्दिष्ट करने पर UTF-8 का उपयोग करें। |
अनुरोध के साथ मदद प्राप्त करें
अंतिम बिंदु, यूटीसी टाइमस्टैम्प, HTTP स्थिति, त्रुटि कोड और अनुरोध या नौकरी ID भेजें। API कुंजी, टोकन निकालें और रिपोर्ट से URLs पर हस्ताक्षर किए।