Registe-se como Desenvolvedor e Obtenha uma Chave de API
Fornece APIs RESTful para tradução de documentos, suportando gestão automatizada de tarefas de tradução, consistência terminológica baseada em glossários e consultas de formatos, idiomas e modelos suportados, facilitando a criação de fluxos de trabalho de tradução integrados e a gestão de contas de utilizador.
Começar
Para começar, precisa de se candidatar para se tornar programador.Candidatar-se como programador
Uma vez aprovado, pode criar múltiplas chaves de API e incluir a chave de API apropriada em cada pedido de API conforme necessário.
Acesso Rápido
URL Base
https://shangyiai.com/api
Método de autenticação
Authorization: [yourSecretKey]
JSON 请求
Exceto a interface de upload de ficheiros, as interfaces usam por padrão pedidos POST JSON, com Content-Type application/json.
Carregamento de ficheiro
A criação de uma tarefa de tradução de documentos utiliza multipart/form-data, o campo file transmite o ficheiro a ser traduzido.
Resposta de erro geral
Quando a solicitação falha, a interface devolve JSON, o campo error contém a mensagem de erro fixa em inglês. Recomenda-se priorizar o tratamento de erros com base no código de status HTTP, o campo error é usado para apresentação ou registo em logs.
{
"error": "Invalid API key."
}Regras de código de estado de erro
Todas as respostas de erro da API v1 mantêm a mesma estrutura, processe de acordo com as seguintes regras de códigos de status HTTP.
- 400 Bad Request
- Parâmetros obrigatórios em falta, formatos de parâmetros ou valores de enumeração inválidos, carregamento de ficheiro em falta, falha ao guardar o carregamento ou falha no processamento da tarefa.
- 401 Unauthorized
- Chave de API ausente ou inválida.
- 402 Payment Required
- Saldo de créditos insuficiente para pré-visualização, tradução completa ou tradução de texto.
- 404 Not Found
- A tarefa ou glossário não existe, foi eliminada, não pertence à conta API atual ou não foi criada através da API.
- 409 Conflict
- O estado atual da tarefa não permite a operação solicitada.
- 500 Internal Server Error
- Exceção inesperada do servidor. O erro de resposta está fixo como "Erro interno do servidor.".
Fluxo de integração recomendado
1. Criar tarefa
Carregar ficheiro e criar tarefa de tradução, retornando o taskId.
2. Consultar progresso
Consultar o estado da tarefa até Completed, Terminated ou Cancelled.
3. Obter resultados
Descarregar ficheiro traduzido ou ler o JSON do original e da tradução.
4. Gerir tarefas
Pagamento conforme a utilização para tradução de texto completo, reiniciar tarefas, rever texto ou apagar tarefas.