API do servidor de tradução humana

Nossa API mais simples

O que é uma API de tradução?

O HTS é um serviço web que permite a integração direta do serviço de tradução da Translated ao seu fluxo de trabalho corporativo ou gerenciador de conteúdo.

O seu CMS chama o HTS para obter orçamentos e fazer pedidos de tradução diretamente com os nossos servidores, exatamente como qualquer cliente faria clicando no widget de Orçamento online do nosso site. Esses pedidos de tradução depois serão devolvidos aos seus sistemas automaticamente, de servidor para servidor.

Os principais benefícios de usar o HTS no seu fluxo de trabalho são:

  • Redução de custos: redução imediata dos custos administrativos e de gerenciamento.
  • Velocidade: seu texto é traduzido e publicado no seu site apenas algumas horas após o pedido ser feito.
  • Robustez: um processo livre de erros para gerenciar conteúdo multilíngue. Chega de copiar e colar.
  • Agilidade: orçamento em tempo real e planejamento de entrega, chega de longas trocas de mensagens para obter um orçamento.

Você paga apenas pelas traduções que você pediu. O HTS não tem custo de instalação nem mensalidade. Os custos das traduções humanas podem ser consultados através do nosso orçamento online. Para maiores informações, entre em contato conosco em hts@translated.com.

Como começar

Esta seção descreve o fluxo de trabalho. A interação com o HTS é basicamente composta por três etapas: orçamento, confirmação e entrega.

Orçamento

Você solicita um orçamento para fazer um pedido em nosso sistema emitindo uma chamada (GET ou POST) no seguinte URL:

Veja um exemplo:

  • A função (f) “quote”
  • Para o cliente (cid) “hts-demo”
  • Com senha (p) "hts-demo5"
  • Do idioma de partida (s) “english”
  • Para o idioma de chegada (t) “japanese”
  • Para o arquivo (text) “blob”
  • Especificando o formato do arquivo (df) “pdf”
  • Para ser devolvido em um ponto de extremidade (endpoint) público exposto em seu site, no caso http://www.yourdomain.com/translations/receive.php

A esta altura, já recebemos o arquivo, armazenamos em nossos sistemas e iniciamos um projeto. Esta chamada fica em espera até que nós recebamos o blob inteiro; quanto mais rápido for o seu link de internet, melhor.

Dica: se você tiver um link de internet lento, considere fazer o upload antecipado do arquivo em algum lugar e, em seguida, enviar-nos o URL dele no parâmetro de texto; consulte a Lista de Funções para obter mais detalhes.

Também precisamos que você especifique o ponto de extremidade onde o arquivo traduzido será entregue. Lembre-se de que sem um ponto de extremidade nós não conseguiremos entregar a tradução para você.

O nosso sistema extrai o texto puro do seu documento, conta as palavras (caso você não tenha informado expressamente a contagem no pedido através do parâmetro w.
Veja a Lista de Funções para saber mais detalhes e receber um orçamento, com:

Significado
1 A chamada foi bem sucedida
OK "OK" ou uma mensagem de erro, quando for o caso
2013-09-26T15:30:00Z Data de entrega garantida em Horário Zulu (ISO 8601)
3082 O número de palavras contadas por nós
216,99 O preço em reais
1040734 O ID deste orçamento (projectID)

Lembre-se de que o seu projeto ainda não foi iniciado, estamos apenas fornecendo as seguintes informações:

  • Custo
  • Estimativa da data e hora de entrega
  • O total de palavras contadas por nós
  • Um número de identificação único do orçamento

Para confirmar o pedido, você deve emitir uma chamada de confirmação

Confirmação

Depois de analisar e aprovar orçamento, confirme o pedido enviando de volta o ID do projeto:

http://www.translated.com/hts/?f=YOUR-REQUIRED-FUNCTION&cid=YOUR-CUSTOMER-ID&p=YOUR-PASSWORD&pid=PROJECT-ID&c=CONFIRMATION-FLAG

Veja um exemplo:

http://www.translated.com/hts/?f=confirm&cid=hts-demo&p=hts-demo5&pid=1040734&c=1
  • A função (f) “confirm”
  • Para o cliente (cid) “hts-demo”
  • Com senha (p) "hts-demo5"
  • Para o projeto (pid) "1040734"
  • Com o sinalizador de confirmação em (c) "1"

Como antes, os métodos GET ou POST funcionam bem. Se a confirmação for bem sucedida, você deverá ver a seguinte resposta:

Significado
1 A chamada foi bem sucedida
OK "OK" ou uma mensagem de erro, quando for o caso

E pronto! O projeto foi confirmado e entregue a um de nossos gerentes de projeto, que escolherá o tradutor mais apto para o seu arquivo. Deste ponto em diante, é fácil.

Entrega

Depois de recebermos o arquivo traduzido do profissional, revisamos tudo cuidadosamente. Se o arquivo passar na verificação de qualidade, o arquivo é enviado de volta para um ponto de extremidade HTTP exposto do seu lado, acordado previamente entre nós (por exemplo: http://www.your-domain.com/translations/receive.php).

Esse ponto de extremidade deve estar preparado para receber um POST de nós a qualquer momento, com os seguintes campos:

  • pid: id do projeto
  • t: o idioma de chegada
  • text: o blob do arquivo traduzido (codificação base64)

Caso seu pedido inclua vários idiomas de chegada, você receberá uma chamada para cada um deles. A principal diferença em relação ao orçamento é que o orçamento é uma função “orientada para pull” acionada por você, já a entrega é uma função “orientada para push” acionada por nós.

Gostaria de dar um exemplo prático.

Parâmetro Descrição
Código de retorno 1 se a entrega foi bem sucedida
0 se houve um erro
Mensagem de erro "OK" se não houve erro, ou então a mensagem de erro.
A mensagem de erro deve ser legível, explicando o que deu errado.

Para um fluxo de trabalho personalizado para retorno de chamada, entre em contato conosco no hts@translated.com.

Ambiente de teste

A nossa API inclui um ambiente sandbox para testes, o que permite gerar e enviar solicitações de tradução sem de fato fazer um pedido real. O ambiente sandbox representa uma abstração precisa do procedimento da API e permite ver todo o processo em ação, desde o orçamento até a entrega.

Ao confirmar um projeto para o qual você solicitou um orçamento (“f=confirm”), basta adicionar o parâmetro “sandbox=1” para confirmá-lo como um teste de API, assim:

http://www.translated.com/hts/?f=confirm&cid=hts-demo&p=hts-demo5&pid=1040734&c=1&sandbox=1

Observe que a função de orçamento é a mesma para testes e produção. Além disso, o texto da mensagem entregue não será a tradução, mas sim o mesmo texto enviado por você ao solicitar o orçamento, já que o propósito disso é criar um projeto de teste de tradução via API.

Caso haja vários idiomas de chegada no orçamento, você receberá várias entregas em intervalos de tempo aleatórios que podem variar entre 30 segundos e 2 minutos.

O comportamento do sandbox reflete o comportamento real e permite que você teste todo o loop para a integração.

Lista de funções

Em cada tabela, os parâmetros obrigatórios são exibidos em vermelho.

Solicite um orçamento

Essa função retorna o preço e a data de entrega de uma tradução humana. Este é o primeiro passo para solicitar uma tradução humana usando a nosso HTS.

Requer pelo menos o texto ou o parâmetro w para retornar uma resposta válida. Isso significa que você pode obter um orçamento válido sem de fato enviar seu documento, se pelo menos informar a contagem de palavras.

A função de orçamento aceita os seguintes parâmetros:

Parâmetro Descrição Padrão Exemplo
cid Nome de usuário / cid=hts-demo
p Senha / p=hts-demo5
s Idioma de partida / s=English
t Idioma(s) de chegada.
Valores separados por vírgula para vários idiomas de chegada
/ t=Italiant
=Italian,Spanish,Japanese
text O conteúdo a ser traduzido. Pode ser um texto simples em linha ou um URL para o arquivo.
Isso é opcional se o parâmetro w tiver sido especificado.
/ text=Hello world
text="http://www.translated.com/hts/HTS_Tech_Spec.pdf"
pn Nome do projeto HTS­-NONAME pn=Translation for tomorrow nr°2
jt Tipo de serviço:

T para Profissional
R para Premium
P para Econômico
T jt=R
w Número de palavras no arquivo.
Esse parâmetro evita que o nosso servidor calcule a contagem de palavras do arquivo em tempo real, resultando em respostas mais rápidas.
/ w=5120
df Formato dos dados, como a extensão do arquivo. Necessário para contagem automática de palavras. A contagem automática de palavras está disponível apenas para: 'pdf', 'plaintext','txt', 'xml', 'html', 'htm', 'xliff', 'zip','rtf', 'doc','docx' e 'aea'. Especifique "zip" para enviar vários arquivos compactados, nós identificaremos automaticamente o formato dos arquivos. / df=zip
tm Uma memória de tradução que você deseja usar neste projeto. Assim como no parâmetro "text", pode ser um arquivo ou um URL. Você também pode informar uma chave MyMemory. / tm=
823yuc908237tm=http://www.yousite.net/hts/some_memory.tmx
endpoint O URL no qual deseja receber a tradução. Aconselhamos
codificar o seu ponto de extremidade em URL para evitar problemas de análise, especialmente quando o link contém "&" ou outros caracteres especiais.
/ endpoint=http://www.mysite.com/path/to/mypage.extURL
­-encoded:endpoint=http%3A%2F%2Fwww.mysite.com%2Fpath%2Fto%2Fmypage.ext
subject O assunto do documento enviado. Consulte a lista de assuntos compatíveis com o método de API para ver a lista completa. geral subject=accounting_finance
instruções Especifique instruções para o tradutor, em texto sem formatação / instructions=deixar tudo em minúscula; datas em formato dos EUA

Exemplo

http://www.translated.com/hts/?f=quote&cid=hts-demo&p=hts-demo5&s=english&t=japanese,italian&text=http://www.translated.com/hts/HTS_Tech_Spec.pdf&df=pdf&jt=P&pn=SimpleTest&w=3000

A função de orçamento retorna os seguintes campos:

Parâmetro Descrição Exemplo
return code 1 se o orçamento foi bem sucedido, 0 se ocorreu um erro 1
mensagem de erro "OK" se não houve erro, caso contrário, a mensagem de erro OK
delivery date A data e a hora que representam o prazo garantido para o pedido, de acordo com a norma ISO 8601: AAAA­-MM­-DDTHH:mm:SSZ 2013­-02­-18T12:32:00Z
word count Número de palavras informadas no parâmetro "text", contadas por nós ou enviadas pelo usuário com o parâmetro "w" 456
custo em euros Custo em euros para o pedido, em forma de número sem separador de milhar e com "." como separador decimal 223.33
project ID O ID do projeto que deverá ser usado para confirmar o pedido 10454289
Confirmar o pedido

Esta função confirma um orçamento para tradução humana solicitado anteriormente. Este é a segunda e última etapa para fazer um pedido de tradução humana usando o HTS.

A função confirmar aceita os seguintes parâmetros:

Parâmetro Descrição Padrão Exemplo
cid Nome de usuário / cid=hts-demo
p Senha / p=hts-demo5
pid O ID do projeto que deverá ser usado para confirmar o pedido. / pid=10454289
c Sinalizador de confirmação.
Você confirma um orçamento dentro da função "confirm" atribuindo 1 a este parâmetro e recusa-o atribuindo 0.
/ c=1
c=0
sandbox Modo Sandbox. Nesse modo, o projeto é considerado um teste e o conteúdo a ser traduzido é enviado para o ponto de extremidade sem alterações. Nenhuma cobrança é aplicada. 0 sandbox=1
text O conteúdo a ser traduzido. Pode ser:

um texto simples em linha/blob binário
um URL para o arquivo
/ text=Hello world
text=http://www.translated.com/hts/HTS_Tech_Spec.pdf

Exemplo

http://www.translated.com/hts/?f=confirm&cid=hts-demo&p=hts-demo5&c=1&pid=232451

A função confirmar retorna os seguintes campos:

Parâmetro Descrição Exemplo
return code 1 se o orçamento foi bem sucedido, 0 se ocorreu um erro 1
mensagem de erro "OK" se não houve erro, caso contrário, a mensagem de erro OK
Obter o status do projeto em tempo real

Esta função permite acompanhar o status de todo o projeto enviado.

A função status aceita os seguintes parâmetros:

Parâmetro Descrição Padrão Exemplo
cid Nome de usuário / cid=hts-demo
p Senha / p=hts-demo5
pid O ID do projeto que deverá ser usado para confirmar o pedido. / pid=10454289

Exemplo

http://www.translated.com/hts/?f=status&cid=hts-demo&p=hts-demo5&c=1&pid=232451

A função status retorna os seguintes campos:

Parâmetro Descrição Exemplo
return code 1 se o orçamento foi bem sucedido, 0 se ocorreu um erro 1
mensagem de erro "OK" se não houve erro, caso contrário, a mensagem de erro OK
lista de tarefas do projeto, uma por linha, com valores separados por ponto e vírgula Uma linha de tarefas é formada por: id;job_type;source;target;words;customer_total;order_date;delivery_date;pm;pm_email one line job:
9687796;REVISION;Italian;English;182;10.00;IN PROCESS;2012­-11­-29 T15:35:00Z;2013­-01-­25 T16:00:00Z;GIANFRANCO;gianfranco@translated.com
Lista de idiomas compatíveis

Esta função mostra a lista de códigos dos idiomas aceitos para tradução humana (para os parâmetros "source" e "target" do orçamento e funções de confirmação). A lista contém o código RFC 3066 e os códigos ISO de duas e três letras.

Essa função deve ser usada para atualizar periodicamente a lista de idiomas compatíveis no seu sistema

A função II aceita os seguintes parâmetros:

Parâmetro Descrição Padrão Exemplo
cid Nome de usuário / cid=hts-demo
p Senha / p=hts-demo5

Exemplo

http://www.translated.com/hts/?f=ll&cid=hts-demo&p=hts-demo5

A função II retorna os seguintes campos:

Parâmetro Descrição Exemplo
return code 1 se o orçamento foi bem sucedido, 0 se ocorreu um erro 1
list of languages Uma linha de idiomas é composta por: nome do idioma;código RFC3066;código ISO 6391;código ISO 6392 Amharic;am­AM;am;amh
Lista de assuntos compatíveis

Esta função mostra a lista de códigos de assunto aceitos para tradução humana. Essa função deve ser usada para atualizar periodicamente a lista de assuntos compatíveis no seu sistema

A função assuntos aceita os seguintes parâmetros:

Parâmetro Descrição Padrão Exemplo
cid Nome de usuário / cid=hts-demo
p Senha / p=hts-demo5

Exemplo

http://www.translated.com/hts/?f=ll&cid=hts-demo&p=hts-demo5

A função assuntos retorna os seguintes campos:

Parâmetro Descrição Exemplo
return code 1 se o orçamento foi bem sucedido, 0 se ocorreu um erro 1
list of subjects O assunto do documento que você deseja traduzir accounting_
financeaerospace_
defencearchitecture

Perguntas frequentes

Qual é a data de validade um orçamento não confirmado solicitado via HTS?
Os orçamentos são válidos por 24 horas.
Que tipo de arquivos são aceitos?
Nós aceitamos todos os tipos de arquivo, pois o HTS é apenas uma maneira de fazer pedidos e transferir arquivos diretamente para os nossos servidores. No entanto, recursos avançados, como a contagem automática de palavras, estão disponíveis somente para pdf, txt, xml, html, xliff, rtf, doc, docx e aea. Para outros formatos, você deve fazer a contagem manual de palavras e, em seguida, nos enviar essa quantidade exata através do parâmetro específico (consulte a função orçamento na Lista de funções).
Como as traduções são entregues? Via e-mail? FTP?
Os documentos são entregues via HTTP POST em um ponto de extremidade público de sua escolha. Lembre-se de nos enviar essa informação ou não conseguiremos entregar suas traduções.
Como é o processo de pagamento?
Nós enviamos uma fatura para cada projeto, com um prazo de 5 dias para o pagamento. Para volume maiores ou casos de uso regular, podemos providenciar pagamentos mensais.
O preço é o mesmo para uma tradução de texto simples?
Sim, não há variação de preço. Lembre-se de que quanto mais processos forem necessários para extrair o texto do arquivo, maior o tempo necessário.
Por que, para o mesmo arquivo, a contagem de palavras é ligeiramente diferente em diferentes formatos?
O sistema automatiza a contagem de palavras analisando o arquivo, extraindo o texto puro e contando as palavras. Formatos de arquivos mais complexos, como de Word, podem incluir metadados adicionais (comentários, informações do autor, etc.) que são extraídos também. Isso pode causar pequenas diferenças na contagem de palavras. A Translated garante que uma análise completa de cada arquivo é conduzida por nossos gerentes de projeto para assegurar que não haja nenhuma discrepância significante na contagem de palavras antes de iniciar a tradução.
Posso usar a API mesmo se o meu tipo de arquivo não for compatível com a contagem automática de palavras?
Sim. O nosso HTS aceita qualquer tipo de arquivo; os formatos de dados compatíveis se referem apenas à contagem de palavras automatizada on-line.
Mas eu queria muito usar a contagem automática de palavras no meu tipo de arquivo!
Entre em contato no hts@translated.com para conversarmos sobre isso.
E se eu quiser traduzir o mesmo arquivo de partida para vários idiomas?
Envie uma lista de valores separados por vírgula no parâmetro “t” da chamada, assim:
http://www.translated.com/hts/?f=quote&cid=hts-demo&p=hts-demo5&s=english&t=japanese,italian,spanish&text=blob&df=pdf&endpoint=http://www.your-domain.com/translations/receive
E se eu quiser apenas receber um orçamento sem realmente enviar o arquivo?
Use o parâmetro "w" para informar o número de palavras, em vez do parâmetro "text", assim:
http://www.translated.com/hts/?f=quote&cid=hts-demo&p=hts-demo5&s=english&t=japanese&w=1000&df=pdf&endpoint=http://www.your-domain.com/translations/receive
Existe algum outro formato de saída para as respostas da API?
Nossa API, por padrão, responde em texto puro, no entanto, se você especificar "of=json", ela retornará um JSON. Este parâmetro opcional adicional é suportado por todas as funções da API (“orçamento”, “confirmar”,“status”, “ll”, “assuntos”).
Existe algum ambiente de testes?
A nossa API oferece um ambiente seguro para verificar todo o ciclo de orçamento/confirmação/entrega, sem precisar fazer um pedido real. Nenhuma cobrança será aplicada a projetos do sandbox e não há limites para o número de projetos desse tipo que um usuário pode fazer. Veja uma explicação detalhada na seção relacionada.

Ainda tem dúvidas?

Nossa equipe está pronta para ajudar você na implementação do HTS.

Fale conosco