Documentação da API de tradução

Autenticação, primeira consulta segura e ciclo da encomenda, com exemplos em PHP nativo. A API v1 suporta texto, documentos e áudio conforme as permissões da conta.

URL basehttps://api.translate24.pro/v1

Acesso e autenticação

Contacte-nos para acordar a conta e as permissões. As contas nativas usam um token Bearer fornecido. Esta versão não tem painel de criação autónoma de chaves de empresa. Contacte-nos

Authorization: Bearer YOUR_API_TOKEN

Guarde o token numa variável de ambiente ou configuração protegida do servidor. Use HTTPS. Não coloque credenciais em URL, JavaScript do navegador ou repositórios públicos.

Um hash de palavra-passe guardado não é uma palavra-passe de API. O SSO do site e a autenticação da API são mecanismos distintos.

Primeira consulta

Comece por consultar o perfil. Esta chamada não cria encomendas nem debita o saldo.

cURL
curl --request GET \
  'https://api.translate24.pro/v1/user/view' \
  --header "Authorization: Bearer $TRANSLATE24_API_TOKEN" \
  --header 'Accept: application/json'

Defina TRANSLATE24_API_TOKEN no servidor. Verifique o estado HTTP e o JSON: uma resposta de perfil bem-sucedida contém um objeto user.

Leia os catálogos atuais e use os identificadores devolvidos. Os IDs de exemplo podem não estar disponíveis para a sua conta.

  • GET /languages/get-pairs
  • GET /languages/get-themes
  • GET /languages/get-types
  • GET /order/get-data-for-create-order

PHP nativo

Este exemplo apenas de leitura usa a extensão cURL do PHP, sem framework.

PHP
<?php
$token = getenv('TRANSLATE24_API_TOKEN');
if (!is_string($token) || $token === '') {
    throw new RuntimeException('API token is not configured.');
}

$ch = curl_init('https://api.translate24.pro/v1/user/view');
if ($ch === false) {
    throw new RuntimeException('Unable to initialize cURL.');
}
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_FOLLOWLOCATION => false,
    CURLOPT_CONNECTTIMEOUT => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $token,
        'Accept: application/json',
    ],
]);
$body = curl_exec($ch);
$httpStatus = (int) curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($body === false) {
    // Keep diagnostic details in a protected server log.
    throw new RuntimeException('API connection failed.');
}
$data = json_decode($body, true, 512, JSON_THROW_ON_ERROR);
if ($httpStatus < 200 || $httpStatus >= 300) {
    throw new RuntimeException('API HTTP error: ' . $httpStatus);
}
if (!is_array($data) || isset($data['errors'])
    || !isset($data['user']) || !is_array($data['user'])) {
    throw new RuntimeException('Unexpected API response.');
}
$user = $data['user'];

Guarde o perfil no servidor e apresente apenas os campos necessários. O exemplo não imprime dados de clientes nem credenciais.

Ciclo da encomenda

  1. Escolha o par de idiomas, tipo e tema nos catálogos. POST /order/create-as-draft cria um registo sem iniciar automaticamente trabalho pago.
  2. Verifique errors, order, price e infoMessage na resposta. Alguns documentos exigem contagem manual de palavras.
  3. POST /order/in-work?id=ORDER_ID&pay_by=1 pode debitar o saldo e iniciar trabalho. Obtenha aprovação explícita antes da chamada.
  4. Acompanhe o progresso com GET /order/view?id=ORDER_ID ou GET /order/index. Limite a frequência das consultas.

Campos do pedido de rascunho

Campos do pedido de rascunhoSignificado
type1: texto · 2: ficheiros · 3: áudio
source_type1: resultado em texto · 2: resultado em áudio
language_pair_idID do catálogo ou from_language_code e to_language_code.
translate_type_idID do tipo de tradução no catálogo
translate_theme_idID do tema no catálogo
source_textTexto de origem de uma encomenda de texto
uploadSourceFiles[]Carregamentos multipart de ficheiros ou áudio
user_idOpcional: cliente criado pelo parceiro autenticado. Caso contrário, a encomenda pertence à conta autenticada.

Use campos de formulário para texto e multipart/form-data para ficheiros. Deixe o cliente HTTP gerar o delimitador multipart.

Em in-work, pay_by=1 usa o saldo da conta autenticada; pay_by=2 o saldo do proprietário da encomenda e exige direitos de parceiro e relação com o cliente adequados.

Ficheiros e áudio

Documentos: txt, odt, pdf, docx; até 5 ficheiros de 5 MiB cada. Áudio: mp3, ogg, webm; até 5 ficheiros de 15 MiB cada.

Verifique cada resposta de carregamento. Um ID de encomenda não autoriza trabalho pago se a análise ou a contagem de palavras falhar.

Erros e novas tentativas

401: verifique autenticação. 403: verifique permissões. 404: verifique ID e titularidade. Uma resposta 2xx com errors é uma falha da aplicação; algumas validações usam HTTP 200.

Após um timeout ou 5xx, a escrita pode já ter ocorrido. Verifique o estado antes de repetir. Não repita automaticamente criação, pagamento ou eliminação: não há contrato publicado de chaves de idempotência. As leituras podem ser repetidas de forma limitada e com espera.

Contas externas

As contas externas usam o mecanismo Basic previsto e apenas leem o próprio perfil, histórico de traduções e catálogos permitidos. Não podem criar, submeter ou eliminar encomendas. Acorde uma conta nativa de integração ou parceiro para escrita.

Referência de endpoints

Os caminhos são relativos ao URL base. O acesso depende das permissões. Consulte o Swagger para os parâmetros ou contacte-nos para obter acesso.

MétodoCaminhoFinalidade
GET/user/viewO seu perfil
GET/user/listClientes do parceiro
POST/user/registrationCriar cliente do parceiro
POST/user/deleteEliminar cliente do parceiro
GET/order/indexEncomendas acessíveis
GET/order/viewDetalhes da encomenda
GET/order/get-data-for-create-orderOpções da encomenda
POST/order/create-as-draftCriar rascunho
POST/order/in-workAprovar pagamento e iniciar trabalho
POST/order/deleteEliminar encomenda permitida
GET/languages/get-pairsPares de idiomas
GET/languages/get-themesTemas
GET/languages/get-typesTipos de tradução

Swagger ↗ · Contacte-nos