Chamar a API a partir de JavaScript

Traduza JSON a partir de um servidor Node.js, aguarde o resultado e guarde-o num ficheiro.

Utilize a implementação nativa de fetch para traduzir conteúdo estruturado a partir do seu servidor. Este exemplo traduz um título das definições da conta de inglês para francês e guarda-o como settings.fr.json. Precisa do Node.js 22 ou de uma versão posterior e de um motor configurado com um modelo de tradução.

Mantenha as credenciais no servidor. O ambiente de execução do React apresenta os catálogos sem precisar de uma chave de API.

Configurar o pedido #

Crie uma chave de API com acesso de tradução ao seu motor e localize os IDs da organização e do motor. Para este exemplo, utilize um motor com a revisão humana desativada.

sh
export LINGO_API_KEY="YOUR_API_KEY"
export LINGO_ORGANIZATION_ID="YOUR_ORGANIZATION_ID"
export LINGO_ENGINE_ID="YOUR_ENGINE_ID"
export LINGO_REQUEST_ID="settings-v1-fr"

Reutilize LINGO_REQUEST_ID ao repetir este envio. Escolha um novo valor se o conteúdo de origem, os idiomas ou outras opções do pedido mudarem.

Traduzir e guardar o resultado #

Guarde este código como translate.mjs:

js
import { writeFile } from "node:fs/promises";
import { setTimeout as delay } from "node:timers/promises";

const apiKey = process.env.LINGO_API_KEY;
const orgId = process.env.LINGO_ORGANIZATION_ID;
const engineId = process.env.LINGO_ENGINE_ID;
const requestId = process.env.LINGO_REQUEST_ID;
if (!apiKey || !orgId || !engineId || !requestId) {
  throw new Error("Set LINGO_API_KEY, LINGO_ORGANIZATION_ID, LINGO_ENGINE_ID, and LINGO_REQUEST_ID");
}

async function request(path, options = {}) {
  const response = await fetch(new URL(path, "https://api.lingo.dev"), {
    ...options,
    headers: { "X-API-Key": apiKey, ...options.headers },
    signal: AbortSignal.timeout(30_000),
  });
  if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
  return response;
}

let job = await (
  await request(`/v2/organizations/${encodeURIComponent(orgId)}/localization/jobs`, {
    method: "POST",
    headers: { "Content-Type": "application/json", "Idempotency-Key": requestId },
    body: JSON.stringify({
      engineId,
      sourceLocale: "en",
      targetLocales: ["fr"],
      documents: [
        {
          key: "settings.json",
          format: { type: "json" },
          source: { content: { heading: "Account settings" } },
        },
      ],
    }),
  })
).json();
await writeFile("job.json", JSON.stringify({ id: job.id, requestId }, null, 2));
if (job.uploads.length) throw new Error("Upload the missing artifacts before starting");

const jobPath = `/v2/localization/jobs/${encodeURIComponent(job.id)}`;
job = await (await request(`${jobPath}/start`, { method: "POST" })).json();

const deadline = Date.now() + 120_000;
while (["Pending", "Running"].includes(job.status._tag)) {
  if (Date.now() >= deadline) throw new Error(`Still waiting for ${job.id}; keep job.json and check again later`);
  await delay(2000);
  job = await (await request(jobPath)).json();
}

const target = job.documents
  .find((document) => document.key === "settings.json")
  ?.targets.find((item) => item.locale === "fr");
if (target?.status._tag !== "Completed") {
  throw new Error(`Translation did not complete: ${JSON.stringify(job.status)}`);
}
const translated = await (await request(target.status.downloadUrl)).json();
if (typeof translated.heading !== "string") throw new Error("The result is missing its heading");
await writeFile("settings.fr.json", JSON.stringify(translated, null, 2) + "\n");
console.log("Saved settings.fr.json");

Execute node translate.mjs, abra settings.fr.json e verifique o título em francês. O programa guarda o ID da tarefa antes de iniciar o trabalho e só descarrega o resultado quando o processamento do destino estiver concluído.

A função auxiliar de pedidos verifica o estado HTTP antes de ler a resposta. Em caso de erro HTTP, utilize o estado e os detalhes do problema para determinar o que corrigir. Pode ocorrer um erro de rede ou ser atingido o tempo limite depois de o servidor aceitar o trabalho.

Continuar após uma interrupção #

Leia o ID em job.json e obtenha a tarefa para continuar a verificar o seu estado. Se a resposta de criação se tiver perdido antes de o ficheiro ser guardado, repita o pedido com a mesma chave de idempotência. Repetir /start permite continuar a mesma tarefa. Quando o tempo limite é atingido, o programa deixa de aguardar, mas o trabalho no servidor não é cancelado.

Para uma aplicação que processa muitos envios ou aguarda revisão humana, crie um workflow de tradução que guarde os IDs das tarefas e as revisões do conteúdo de origem e recolha os resultados num processo de trabalho. Traduzir ficheiros explica o carregamento de artefactos e os resultados parciais em vários idiomas.