Está disponível um conjunto de chamadas de API que permitem:
-
integração do phrase e de qualquer software de terceiros (Ferramentas de gerenciamento de tradução, CMSs, etc.)
-
Desenvolvimento do ambiente de trabalho de um tradutor. O editor CAT é construído sobre APIs públicas.
-
Criação de uma nova ferramenta ou serviço usando o phrase em seu backend.
Fluxo de trabalho básico
Os procedimentos e fluxos de trabalho devem ser entendidos antes de usar APIs. Recomenda-se conhecer um procedimento no phrase antes de implementar a API relacionada.
O fluxo de trabalho básico é:
-
Crie uma memória de tradução, um glossário e, opcionalmente, adicione um mecanismo de tradução automática.
-
Crie um projeto com o mecanismo anexado à memória de tradução/glossário/tradução automática (se necessário).
-
Gravar o projeto como um modelo de projeto e reutilizá-lo para criar um novo projeto de tradução.
-
Upload do arquivo para tradução para o projeto (criar um trabalho).
-
Você pode analisar, pré-traduzir ou atribuir o trabalho a um linguista.
APIs assíncronas
As APIs assíncronas devem sempre ser preferidas a suas contrapartes sincronas. Ao ligar para APIs sincronizadas, há a chance de receber respostas expiradas após tempo limite ao processar lotes grandes de arquivos ou mesmo um único arquivo grande. As APIs sincronizadas só devem ser usadas em arquivos pequenos e integração de pequena escala.
Polling
Após ligar para uma API assíncrona, é recebida uma resposta instantânea contendo a solicitação de identificador. Use esse identificador para verificar o estado da solicitação, chamando getAsyncRequest e marcando o campo asyncResponse. Esta abordagem de polêmico pode levar a um número de chamadas getAsyncRequest antes de receber um asyncResponse que não seja nulo.
Chamadas
Como resposta às desvantagens do modo de polêmica para solicitações assíncronas, há suporte para chamadas de retorno em todas as APIs assíncronas. Ao convocar uma solicitação assíncrona, especifique uma URL (no parâmetro callbackUrl) que é solicitada após o trabalho iniciado pela solicitação assíncrona Concluir.
As chamadas de retorno são solicitadas por meio de chamadas HTTP POST e os dados são transmitidos no corpo codificado como JSON. O objeto JSON sempre contém:
-
Informações sobre a solicitação assíncrona (igual ao chamando getAsyncRequest).
-
Informações detalhadas sobre o resultado da ação, como uma análise completa ou detalhes do trabalho.
{
"asyncRequest": {
...
}
"analyse": {
...
}
}
Se um URL de retorno não estiver acessível, a solicitação será repetida após 2, 4, 8, 16 e 30 minutos até que 10 repetições falhem.
O URL de retorno deve responder com o código de estado HTTP de 200 OK para ser considerado bem-sucedido.