Introducción
Proporciona APIs RESTful para la traducción de documentos, con soporte para la gestión automatizada de tareas de traducción, coherencia terminológica basada en glosarios y consultas sobre formatos, idiomas y modelos compatibles, facilitando la creación de flujos de trabajo de traducción eficientes y la gestión de cuentas de usuario.
Primeros pasos
Para comenzar, debe solicitar convertirse en desarrollador.Solicitar como desarrollador
Una vez aprobado, podrá crear múltiples claves API e incluir la clave API correspondiente en cada solicitud API según sea necesario.
Acceso rápido
Base URL
https://shangyiai.com/api
Método de autenticación
Authorization: [yourSecretKey]
Solicitud JSON
Excepto la interfaz de carga de archivos, las interfaces utilizan por defecto solicitudes POST JSON, con Content-Type application/json.
Carga de archivo
La creación de una tarea de traducción de documentos utiliza multipart/form-data, el campo file envía el archivo a traducir.
Respuesta de error general
Cuando la solicitud falla, la interfaz devolverá JSON, el campo error contiene un mensaje de error fijo en inglés. Se recomienda priorizar el manejo de errores por código de estado HTTP, el campo error se utiliza para mostrar o para registro en logs.
{
"error": "Invalid API key."
}Reglas de código de estado de error
Todas las respuestas de error de la API v1 mantienen la misma estructura, procéselas según las siguientes reglas de código de estado HTTP.
- 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.".
Proceso de integración recomendado
1. Crear tarea
Cargar archivo y crear tarea de traducción, devuelve el taskId.
2. Consultar progreso
Consultar el estado de la tarea hasta que esté Completed, Terminated o Cancelled.
3. Obtener resultado
Descargar archivo de traducción, o leer el JSON del original y la traducción.
4. Gestionar tareas
Paga según el uso por traducción de texto completo, reinicio de tareas, revisión de textos o eliminación de tareas.