ลงทะเบียนเป็นนักพัฒนาและรับ API Key
ให้บริการ RESTful APIs สำหรับการแปลเอกสาร รองรับการจัดการงานแปลอัตโนมัติ ความสอดคล้องของศัพท์เฉพาะตาม glossary และการสอบถามรูปแบบ ภาษา และโมเดลที่รองรับ ทำให้สามารถสร้างเวิร์กโฟลว์การแปลที่ราบรื่นและจัดการบัญชีผู้ใช้ได้อย่างง่ายดาย
การเริ่มต้นใช้งาน
ในการเริ่มต้น ท่านจำเป็นต้องสมัครเป็นนักพัฒนาสมัครเป็นนักพัฒนา
เมื่อได้รับอนุมัติแล้ว คุณสามารถสร้าง API keys หลายตัวและใส่ API key ที่เหมาะสมในแต่ละคำขอ API ตามที่จำเป็น
เชื่อมต่อด่วน
URL พื้นฐาน
https://shangyiai.com/api
วิธีการรับรอง
Authorization: [yourSecretKey]
คำขอ JSON
นอกจากอินเทอร์เฟซอัปโหลดไฟล์ อินเทอร์เฟซจะใช้คำขอ POST JSON โดยค่าเริ่มต้น โดย Content-Type เป็น application/json
อัปโหลดไฟล์
การสร้างงานแปลเอกสารใช้ multipart/form-data โดยส่งไฟล์ที่ต้องการแปลผ่านฟิลด์ file
การตอบสนองข้อผิดพลาดทั่วไป
เมื่อคำขอล้มเหลว interface จะส่งกลับ JSON โดยฟิลด์ error จะมีข้อความแสดงข้อผิดพลาดเป็นภาษาอังกฤษที่คงที่แนะนำให้จัดการข้อผิดพลาดตาม HTTP status code เป็นหลัก โดยใช้ฟิลด์ error สำหรับการแสดงผลหรือบันทึกใน log
{
"error": "Invalid API key."
}กฎรหัสสถานะข้อผิดพลาด
การตอบสนองข้อผิดพลาดของ v1 API ทั้งหมดคงโครงสร้างเดียวกัน โปรดจัดการตามกฎรหัสสถานะ HTTP ต่อไปนี้
- 400 Bad Request
- ไม่มีพารามิเตอร์ที่จำเป็น รูปแบบพารามิเตอร์หรือค่า enum ไม่ถูกต้อง ไม่มีการอัปโหลดไฟล์ การบันทึกไฟล์ที่อัปโหลดล้มเหลว หรือการประมวลผลงานล้มเหลว
- 401 Unauthorized
- ไม่มี API key หรือ API key ไม่ถูกต้อง
- 402 Payment Required
- เครดิตไม่เพียงพอสำหรับการดูตัวอย่าง การแปลแบบเต็ม หรือการแปลข้อความ
- 404 Not Found
- งานหรืออภิธานศัพท์ไม่มีอยู่ ถูกลบไปแล้ว ไม่ได้เป็นของบัญชี API ปัจจุบัน หรือไม่ได้ถูกสร้างผ่าน API
- 409 Conflict
- สถานะงานปัจจุบันไม่อนุญาตให้ดำเนินการที่ร้องขอ
- 500 Internal Server Error
- ข้อผิดพลาดของเซิร์ฟเวอร์ที่ไม่คาดคิด.ข้อผิดพลาดในการตอบสนองถูกกำหนดเป็น "Internal server error."
กระบวนการเชื่อมต่อที่แนะนำ
1. สร้างงาน
อัปโหลดไฟล์และสร้างงานแปล คืนค่า taskId
2. ตรวจสอบความคืบหน้า
polling สถานะงานจนกว่าจะเป็น Completed, Terminated หรือ Cancelled
3. รับผลลัพธ์
ดาวน์โหลดไฟล์แปล หรืออ่านไฟล์ JSON ของต้นฉบับและคำแปล
4. จัดการงาน
จ่ายตามการใช้งานสำหรับการแปลฉบับเต็ม การเริ่มงานใหม่ การแก้ไขข้อความ หรือการลบงาน