डेवलपर के रूप में पंजीकरण करें और एक API कुंजी प्राप्त करें
दस्तावेज़ अनुवाद के लिए RESTful APIs प्रदान करता है, स्वचालित अनुवाद कार्य प्रबंधन, शब्दकोश-आधारित शब्दावली की निरंतरता, और समर्थित प्रारूपों, भाषाओं और मॉडलों के लिए क्वेरी का समर्थन करता है, जिससे निर्बाध अनुवाद वर्कफ़्लो बनाना और उपयोगकर्ता खातों का प्रबंधन करना सुविधाजनक हो जाता है।
प्रारंभ करना
आरंभ करने के लिए, आपको एक डेवलपर बनने हेतु आवेदन करना आवश्यक है।डेवलपर के रूप में आवेदन करें
स्वीकृति के पश्चात्, आप अनेक API कुंजियाँ निर्मित कर सकते हैं और आवश्यकतानुसार प्रत्येक API अनुरोध में उचित API कुंजी सम्मिलित कर सकते हैं।
त्वरित एक्सेस
बेस URL
https://otranslator.com/api
प्रमाणीकरण विधि
Authorization: [yourSecretKey]
JSON अनुरोध
फ़ाइल अपलोड इंटरफ़ेस को छोड़कर, इंटरफ़ेस डिफ़ॉल्ट रूप से POST JSON अनुरोध का उपयोग करता है, Content-Type, application/json है।
फ़ाइल अपलोड
दस्तावेज़ अनुवाद टास्क बनाने के लिए multipart/form-data का उपयोग होता है, file फ़ील्ड में अनुवाद के लिए फ़ाइल पास की जाती है।
सामान्य त्रुटि प्रतिक्रिया
अनुरोध विफल होने पर इंटरफ़ेस JSON लौटाएगा, error फ़ील्ड में निश्चित अंग्रेजी त्रुटि संदेश होता है।HTTP status code के अनुसार त्रुटि प्रबंधन करने की अनुशंसा की जाती है, error फ़ील्ड का उपयोग प्रदर्शन या लॉग रिकॉर्डिंग के लिए करें।
{
"error": "Invalid API key."
}त्रुटि स्टेटस कोड नियम
सभी v1 API त्रुटि प्रतिक्रियाएं समान संरचना बनाए रखती हैं, कृपया निम्नलिखित HTTP status code नियमों के अनुसार प्रोसेस करें।
- 400 Bad Request
- आवश्यक पैरामीटर गुम हैं, अमान्य पैरामीटर प्रारूप या एनम मान, फ़ाइल अपलोड गुम है, अपलोड सहेजने में विफलता, या कार्य प्रसंस्करण विफलता।
- 401 Unauthorized
- API कुंजी गुम है या अमान्य है।
- 402 Payment Required
- पूर्वावलोकन, पूर्ण अनुवाद, या पाठ अनुवाद के लिए क्रेडिट बैलेंस अपर्याप्त है।
- 404 Not Found
- टास्क या ग्लॉसरी मौजूद नहीं है, डिलीट कर दी गई है, वर्तमान API अकाउंट से संबंधित नहीं है, या API के माध्यम से नहीं बनाई गई थी।
- 409 Conflict
- वर्तमान कार्य स्थिति अनुरोधित संचालन की अनुमति नहीं देती है।
- 500 Internal Server Error
- अप्रत्याशित सर्वर अपवाद। प्रतिक्रिया त्रुटि को "Internal server error." के रूप में निर्धारित किया गया है।
अनुशंसित एकीकरण प्रक्रिया
1. कार्य बनाएं
फ़ाइल अपलोड करें और अनुवाद कार्य बनाएं, taskId लौटाता है।
2. प्रगति पूछताछ करें
कार्य स्थिति को पोल करें, जब तक Completed, Terminated या Cancelled न हो जाए।
3. परिणाम प्राप्त करें
अनुवादित फ़ाइल डाउनलोड करें, या मूल एवं अनुवादित JSON पढ़ें।
4. कार्य प्रबंधित करें
पूर्ण पाठ अनुवाद, कार्य पुनः आरंभ करने, पाठ संशोधित करने या कार्य हटाने के लिए मांग के अनुसार भुगतान करें।