سجّل كمطور واحصل على مفتاح API
يوفر واجهات برمجة تطبيقات RESTful لترجمة الوثائق، مع دعم إدارة مهام الترجمة الآلية واتساق المصطلحات القائم على المسارد والاستعلامات حول التنسيقات واللغات والنماذج المدعومة، مما يسهل بناء سير عمل ترجمة سلس وإدارة حسابات المستخدمين.
البدء
للبدء، تحتاج إلى التقدم بطلب لتصبح مطوراً.التقدم كمطور
بمجرد الموافقة، يمكنك إنشاء مفاتيح API متعددة وتضمين مفتاح API المناسب في كل طلب API حسب الحاجة.
الوصول السريع
عنوان URL الأساسي
https://shangyiai.com/api
طريقة المصادقة
Authorization: [yourSecretKey]
طلب JSON
باستثناء واجهة رفع الملفات، تستخدم الواجهات افتراضياً طلبات POST JSON، حيث يكون Content-Type من نوع application/json.
رفع الملف
إنشاء مهمة ترجمة المستند يستخدم multipart/form-data، ويُدخل الملف المراد ترجمته في حقل file.
استجابة الخطأ العامة
عند فشل الطلب، تُرجع الواجهة JSON، حقل error يحتوي على رسالة خطأ إنجليزية ثابتة. يُنصح بمعالجة الأخطاء أولاً حسب رمز حالة HTTP، ويُستخدم حقل error للعرض أو التسجيل.
{
"error": "Invalid API key."
}قواعد رموز حالة الخطأ
تحتفظ جميع استجابات أخطاء v1 API بنفس البنية، يُرجى المعالجة وفقًا لقواعد رمز حالة HTTP التالية.
- 400 Bad Request
- معاملات مطلوبة مفقودة، أو تنسيقات معاملات غير صالحة أو قيم تعداد غير صالحة، أو ملف محمّل مفقود، أو فشل حفظ التحميل، أو فشل معالجة المهمة.
- 401 Unauthorized
- مفتاح API مفقود أو غير صالح.
- 402 Payment Required
- الرصيد غير كافٍ للمعاينة أو الترجمة الكاملة أو ترجمة النص.
- 404 Not Found
- المهمة أو القاموس غير موجود، أو تم حذفه، أو لا ينتمي إلى حساب الواجهة البرمجية الحالي، أو لم يتم إنشاؤه عبر الواجهة البرمجية.
- 409 Conflict
- حالة المهمة الحالية لا تسمح بالعملية المطلوبة.
- 500 Internal Server Error
- استثناء غير متوقع في الخادم. خطأ الاستجابة محدد بـ "خطأ داخلي في الخادم.".
إجراءات الدمج الموصى بها
1. إنشاء مهمة
رفع الملف وإنشاء مهمة ترجمة، وإرجاع taskId.
2. استعلام التقدم
استطلاع حالة المهمة بشكل دوري، حتى تصبح Completed أو Terminated أو Cancelled.
3. الحصول على النتائج
تنزيل ملف الترجمة، أو قراءة JSON للنص الأصلي والنص المترجم.
4. إدارة المهام
الدفع حسب الاستخدام للترجمة الكاملة للنص، أو إعادة تشغيل المهمة، أو مراجعة النص، أو حذف المهمة.