Para gerentes de projeto

Para tradutores

Para desenvolvedores

API v1
Webhooks

Empresa

Criar projeto

Crie o projeto do Crowdin.

Pedido

POST https://api.crowdin.com/api/account/create-project?account-key={account-key}

Parâmetros

Nome Valor Descrição
login obrigatório string Seu nome de login da conta Crowdin.
name obrigatório string Nome do projeto.
identifier obrigatório string Identificador do projeto. Deve ser único entre outros projetos do Crowdin.
source_language obrigatório string Idioma dos arquivos de origem. Código de idioma do Crowdin.
languages obrigatório array Uma matriz de códigos de idioma para o qual um projeto deve ser traduzido.
join_policy obrigatório string Política de adesão ao projeto. Valores aceitáveis são:
  • aberto
  • privado
language_access_policy opcional string Define como os membros do projeto podem acessar os idiomas de destino. Valores aceitáveis são:
  • "open" - qualquer tradutor pode acessar qualquer idioma. (padrão)
  • "moderado" - tradutor deve ser concedido com acesso a determinado idioma.
hide_duplicates opcional int Define se strings duplicadas devem ser exibidas para os tradutores ou se devem ser ocultadas e traduzidas automaticamente. Valores aceitáveis são:
  • 0 - Mostrar - os tradutores irão traduzir cada instância separadamente
  • 1 - Ocultar - todos os duplicados compartilharão a mesma tradução
  • 2 - Mostrar, mas traduzi-los automaticamente
  • 3 - Mostrar (recomendado para versões) - as duplicatas serão ocultas apenas entre as versões
export_translated_only optional bool Define se apenas as frases traduzidas serão exportadas para o arquivo final. Não é recomendável ativar esta opção se você tiver documentos tipo texto (*. html, txt, docx etc) em seu projeto, pois pode danificar arquivos finais. Os valores aceitáveis são: 1 ou 0.
export_approved_only optional bool Se definido como 1 somente as traduções aprovadas serão exportadas no arquivo ZIP resultante. Os valores aceitáveis são: 1 ou 0.
auto_translate_dialects opcional bool As cadeias de caracteres não traduzidas do dialeto serão traduzidas automaticamente no arquivo exportado, aproveitando as traduções do idioma principal. Os valores aceitáveis são: 1 ou 0.
public_downloads opcional bool Define se o botão "Download" fica visível para todos nas páginas do Crowdin. Os valores aceitáveis são: 1 ou 0.
use_global_tm opcional bool Define se as traduções serão aproveitadas da Memória de Tradução Global do Crowdin. Ao usar esta opção, qualquer tradução feita em seu projeto será automaticamente enviada para a Crowdin Global TM. Os valores aceitáveis são: 1 ou 0.
logo opcional arquivo Logotipo do projeto no Crowdin.
cname opcional string Nome de domínio personalizado para o projeto do Crowdin.
description opcional string Descrição do Projeto.
in_context opcional bool Define se o No contexto deve estar ativo no projeto. Os valores aceitáveis são: 1 ou 0.
pseudo_language opcional string Especifique o código de idioma para a pseudo-linguagem do In-Context que armazenará alguns dados operacionais.
qa_checks opcional array Define se as verificações de controle de qualidade devem estar ativas no projeto. Como chave, você deve especificar o parâmetro de verificação de controle de qualidade (Uma visão geral dos parâmetros de verificação de controle de qualidade). Possíveis chaves são:
  • "enabled" — Ativar de desativar as verificações de controle de qualidade
  • "empty" — Tradução vazia
  • "size" — Problemas de comprimento
  • "tags" — Incompatibilidade de etiquetas
  • "spaces" — Incompatibilidade de espaços
  • "variables" — Incompatibilidade de variáveis
  • "punctuation" — Incompatibilidade de pontuação
  • "symbol_register" — Incompatibilidade de maiúsculas e minúsculas
  • "special_symbols" — Caracteres especiais incompatíveis
  • "wrong_translation" — Problemas de "tradução incorreta"
  • "spellcheck" — Soletração
  • "icu" — Sintaxe da UTI
Os valores aceitáveis são: 1 ou 0.
Nota! Esta opção está disponível apenas para planos de organização.
webhook_file_translated opcional string Abra esta URL quando um dos arquivos do projeto for traduzido. O URL será aberto com "project" - identificador do projeto, "language" - código do idioma, "file_id" - identificador do arquivo Crowdin e "file" - nome do arquivo.
webhook_file_proofread opcional string Abra esta URL quando um dos arquivos de projeto for revisado. O URL será aberto com "project" - identificador do projeto, "language" - código do idioma, "file_id" - identificador do arquivo Crowdin e "file" - nome do arquivo.
webhook_project_translated opcional string Abra este URL quando a tradução do projeto estiver concluída. O URL será aberto com "projeto" - identificador do projeto e "idioma" - código do idioma.
webhook_project_proofread opcional string Abra este URL quando a revisão do projeto estiver concluída. O URL será aberto com "projeto" - identificador do projeto e "idioma" - código do idioma.
json opcional string Pode não conter valor. Define que a resposta deve estar no formato JSON.
jsonp opcional string Nome da função de retorno de chamada. Define que a resposta deve estar no formato JSONP.
Variáveis
account-key string Chave da API da conta Crowdin.

Resposta

Se o método for bem sucedido, ele responde com uma estrutura XML, como é mostrado abaixo (quando language_access_policy = open). 
<?xml version="1.0" encoding="UTF-8"?>
<project>
  <success>1</success>
  <invitation>http://translate.example.com/project/test-project-api/invite</invitation>
  <url>http://translate.example.com/project/test-project-api</url>
  <key>ca51cef8f852425496b1cdd3e86fea88</key>
</project>
Exemplo de resposta para projetos com "Moderado"language_access_policy. 
<?xml version="1.0" encoding="UTF-8"?>
<project>
  <success>1</success>
  <invitation>
    <item>
      <language>Ukrainian</language>
      <translator>http://translate.example.com/project/test-project-api/invite?d=7585662585d5d32307d3937373</translator>
      <proofreader>http://translate.example.com/project/test-project-api/invite?d=3585k635r4d5d32307d3937373</proofreader>
    </item>
  </invitation>
  <url>https://crowdin.com/project/test-project-api</url>
  <key>d13720ba72204273af0321ca980945ec</key>
</project>
Amostra de resposta mal-sucedida: 
<?xml version="1.0" encoding="UTF-8"?>
<error>
  <code>12</code>
  <message>Chave da conta não é válida</message>
</error>

Exemplos

curl \
  -F "login=admin" \
  -F "logo=@logo.png" \
  -F "name=This is a test project" \
  -F "identifier=test-project-api" \
  -F "description=Brief Description" \
  -F "hide_duplicates=1" \
  -F "cname=translate.example.com" \
  -F "join_policy=open" \
  -F "languages[]=fr" \
  -F "languages[]=ru" \
  -F "export_approved_only=1" \
  -F "public_downloads=1" \
  -F "source_language=en" \
  -F "qa_checks[enabled]=1" \
  https://api.crowdin.com/api/account/create-project?account-key={account-key}
<?php
$post_params = array();
$request_url = 'https://api.crowdin.com/api/account/create-project?account-key={account-key}';
$post_params['login'] = 'admin';
$post_params['name'] = 'Test Project';
$post_params['identifier'] = 'api-test-project';
$post_params['join_policy'] = 'private';
$post_params['languages[0]'] = 'fr';
$post_params['languages[1]'] = 'uk';
$post_params['source_language'] = 'en';
$post_params['qa_checks[enabled]'] = 1;

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $request_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post_params);

$result = curl_exec($ch);
curl_close($ch);

echo $result;

Este artigo foi útil?