Há 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 foi construído sobre as 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 precisam ser entendidos antes de usar as APIs. Recomenda-se conhecer um procedimento no Phrase antes de implementar a API relacionada.
O fluxo de trabalho básico é:
-
Crie uma TM, TB e, opcionalmente, adicione um motor de tradução automática.
-
Crie um projeto com o mecanismo de tradução automática / memória de tradução anexado (se necessário).
-
Grave o projeto como um modelo de projeto e reuse-o para criar um novo projeto de tradução.
-
Faça upload do seu arquivo para tradução para o projeto (criar um trabalho).
-
Você pode então analisar, pré-traduzir ou atribuir o trabalho a um tradutor.
APIs assíncronas
As APIs assíncronas sempre devem ser preferidas a suas colegas sincronas. Se fazer a chamada de APIs sincronas, há uma chance de receber respostas expiradas quando processando lotes grandes de arquivos ou mesmo um único arquivo grande. As APIs sincronas só devem ser usadas em arquivos pequenos e em integrações de pequena escala.
Polling
Após chamar uma API assíncrona, é recebida uma resposta instantânea contendo a solicitação de identificador. Use esse identificador para verificar a situação da solicitação chamando getAsyncRequest e marcando o campo AsyncResponse. Esta abordagem de polêmica pode levar a um certo número de chamadas getAsyncRequest antes de receber uma asyncResponse que não seja nula.
Callbacks
Como resposta às desvantagens do modo de pesquisa para solicitações assíncronas, o uso de callbacks em todas as APIs assíncronas é permitido. Ao chamar uma solicitação assíncrona, especifique uma URL (no parâmetro callbackUrl) que seja solicitada após a conclusão do trabalho iniciado pela solicitação assíncrona.
Os retorno são solicitados através de chamadas HTTP POST e os dados são passados no corpo codificado como JSON. O objeto JSON contém sempre:
-
Informações sobre a solicitação assíncrona (mesmo que ao chamar 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 tenham falhado.
O URL de retorno deve responder com o código de situação de HTTP 200 OK para ser considerado bem-sucedido.