Đăng ký trở thành nhà phát triển và nhận khóa API
Cung cấp các API RESTful cho việc dịch thuật tài liệu, hỗ trợ quản lý tự động các tác vụ dịch thuật, đảm bảo tính nhất quán thuật ngữ dựa trên bảng thuật ngữ và truy vấn các định dạng, ngôn ngữ cùng mô hình được hỗ trợ, tạo điều kiện thuận lợi để xây dựng quy trình dịch thuật liền mạch và quản lý tài khoản người dùng.
Bắt đầu
Để bắt đầu, bạn cần đăng ký để trở thành nhà phát triển.Đăng ký làm nhà phát triển
Sau khi được phê duyệt, bạn có thể tạo nhiều API key và đưa API key phù hợp vào mỗi yêu cầu API theo yêu cầu.
Kết nối nhanh
URL gốc
https://shangyiai.com/api
Phương thức xác thực
Authorization: [yourSecretKey]
Yêu cầu JSON
Ngoại trừ API tải file lên, các API mặc định sử dụng yêu cầu POST JSON, Content-Type là application/json.
Tải tệp lên
Tạo tác vụ dịch tài liệu sử dụng multipart/form-data, truyền tệp cần dịch vào trường file.
Phản hồi lỗi chung
Khi yêu cầu thất bại, API sẽ trả về JSON, trường error chứa thông tin lỗi bằng tiếng Anh cố định. Nên ưu tiên xử lý lỗi theo HTTP status code, trường error dùng để hiển thị hoặc ghi log.
{
"error": "Invalid API key."
}Quy tắc mã trạng thái lỗi
Tất cả phản hồi lỗi API v1 duy trì cấu trúc giống nhau, vui lòng xử lý theo quy tắc mã trạng thái HTTP dưới đây.
- 400 Bad Request
- Thiếu các tham số bắt buộc, định dạng tham số hoặc giá trị enum không hợp lệ, thiếu tệp tải lên, lưu tệp tải lên thất bại, hoặc xử lý tác vụ thất bại.
- 401 Unauthorized
- Thiếu khóa API hoặc khóa API không hợp lệ.
- 402 Payment Required
- Số dư tín chỉ không đủ để xem trước, dịch đầy đủ hoặc dịch văn bản.
- 404 Not Found
- Nhiệm vụ hoặc bảng thuật ngữ không tồn tại, đã bị xóa, không thuộc về tài khoản API hiện tại, hoặc không được tạo thông qua API.
- 409 Conflict
- Trạng thái tác vụ hiện tại không cho phép thao tác được yêu cầu.
- 500 Internal Server Error
- Ngoại lệ máy chủ không mong đợi. Lỗi phản hồi được sửa thành "Lỗi máy chủ nội bộ.".
Quy trình tiếp cận khuyến nghị
1. Tạo nhiệm vụ
Tải lên tệp và tạo nhiệm vụ dịch thuật, trả về taskId.
2. Kiểm tra tiến độ
Kiểm tra định kỳ trạng thái nhiệm vụ cho đến khi Completed, Terminated hoặc Cancelled.
3. Lấy kết quả
Tải xuống tệp bản dịch, hoặc đọc JSON văn bản gốc và bản dịch.
4. Quản lý nhiệm vụ
Thanh toán theo nhu cầu cho dịch toàn văn, khởi chạy lại tác vụ, chỉnh sửa văn bản hoặc xóa tác vụ.