दस्तावेज़ सूची

परिचय

दस्तावेज़ अनुवाद के लिए RESTful APIs प्रदान करता है, स्वचालित अनुवाद कार्य प्रबंधन, शब्दकोश-आधारित शब्दावली की निरंतरता, और समर्थित प्रारूपों, भाषाओं और मॉडलों के लिए क्वेरी का समर्थन करता है, जिससे निर्बाध अनुवाद वर्कफ़्लो बनाना और उपयोगकर्ता खातों का प्रबंधन करना सुविधाजनक हो जाता है।

प्रारंभ करना

आरंभ करने के लिए, आपको एक डेवलपर बनने हेतु आवेदन करना आवश्यक है।डेवलपर के रूप में आवेदन करें

स्वीकृति के पश्चात्, आप अनेक API कुंजियाँ निर्मित कर सकते हैं और आवश्यकतानुसार प्रत्येक API अनुरोध में उचित API कुंजी सम्मिलित कर सकते हैं।

त्वरित एक्सेस

Base URL

https://shangyiai.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
Missing required parameters, invalid parameter formats or enum values, missing file upload, upload save failure, or task processing failure.
401 Unauthorized
Missing API key or invalid API key.
402 Payment Required
Insufficient credits balance for preview, full translation, or text translation.
404 Not Found
The task or glossary does not exist, has been deleted, does not belong to the current API account, or was not created through the API.
409 Conflict
The current task status does not allow the requested operation.
500 Internal Server Error
Unexpected server exception. The response error is fixed as "Internal server error.".

अनुशंसित एकीकरण प्रक्रिया

संसाधन

अनुवाद कार्य API
अनुवाद कार्य बनाएं