Projekt bearbeiten

Bitte beachten Sie, dass API 2.0 jetzt die bevorzugte Version ist. Die alte API bleibt bis Ende 2021 voll funktionsfähig.

Crowdin API v2
Ein Crowdin-Projekt bearbeiten.

Anfrage

Hinweis: Verwenden Sie die Kombination von Projekt-ID, Nutzername und Kontoschlüssel, um an diesen Endpunkt weiterzugeben.

POST https://api.crowdin.com/api/project/{Projekt-ID}/edit-project?login={Nutzername}&account-key={Kontoschlüssel}

Parameter

Name Wert Beschreibung
name optional String Projektname.
languages optional Array Ein Array von Sprachcodes, in das das Projekt übersetzt werden soll.
join_policy optional String Project join policy. Zulässige Werte sind:
  • open
  • private
language_access_policy optional String Defines how project members can access target languages. Zulässige Werte sind:
  • „open“ - Jeder Übersetzer hat Zugriff auf jede Sprache.
  • "moderate" - translator should be granted with access to certain language.
hide_duplicates optional Int. Defines whether duplicated strings should be displayed to translators or should be hidden and translated automatically. Zulässige Werte sind:
  • 0: Zeigen – Übersetzer müssen jede Zeichenkette einzeln übersetzen
  • 1: Hide (regular detection) - all duplicates will share the same translation
  • 2: Zeigen, aber sie automatisch übersetzen
  • 3: Show within a version branch (regular detection) - duplicates will be hidden only between version branches
  • 4: Hide (strict detection) - all duplicates will share the same translation
  • 5: Show within a version branch (strict detection) - duplicates will be hidden only between version branches
export_translated_only optional Boolean Defines whether only translated strings will be exported to the final file. We do not recommend to set this option if you have text (*.html, *.txt, *.docx etc.) documents in your project since it may damage resulted files. Zulässige Werte sind: 0 und 1.
export_approved_only optional Boolean If set to 1 only approved translations will be exported in resulted ZIP file. Zulässige Werte sind: 0 und 1.
auto_translate_dialects optional Boolean Untranslated strings of dialect will be translated automatically in exported file, leveraging translations from main language. Zulässige Werte sind: 0 und 1.
public_downloads optional Boolean Defines whether "Download" button visible to everyone on Crowdin webpages. Zulässige Werte sind: 0 und 1.
use_global_tm optional Boolean Defines if translations would be leveraged from Crowdin Global Translation Memory. When using this option any translations made in your project will be commited to Crowdin Global TM automatically. Zulässige Werte sind: 0 und 1.
logo optional file Projektlogo auf Crowdin.
cname optional String Custom domain name for Crowdin project.
description optional String Projektbeschreibung.
qa_checks optional Array Defines whether the QA checks should be active in the project. As a key you must specify QA check parameter (An Overview of QA Check Parameters). Possible keys are:
  • „enabled“ – Qualitätskontrollen aktivieren
  • „empty“ – Leere Übersetzung
  • „size“ – Probleme mit der Länge
  • „tags“ – Tags stimmen nicht überein
  • „spaces“ – Leerzeichen stimmen nicht überein
  • „variables“ – Variablen stimmen nicht überein
  • „punctuation“ – Satzzeichen stimmen nicht überein
  • „symbol_register“ – Groß- und Kleinschreibung stimmen nicht überein
  • „special_symbols“ – Sonderzeichen stimmen nicht überein
  • „wrong_translation“ – „Fehlerhafte Übersetzung“-Probleme
  • „spellcheck“ – Rechtschreibprüfung
  • „icu“ – ICU-Syntax
Zulässige Werte sind: 0 und 1.
Note! This option is available only for organization plans.
webhook_file_translated optional String Open this URL when one of the project files is translated. Open this URL when one of the project files is translated.
webhook_file_proofread optional String Open this URL when one of the project files is proofread. Open this URL when one of the project files is translated.
webhook_project_translated optional String Open this URL when project translation is complete. URL will be opened with "project" - project identifier and "language" - language code.
webhook_project_proofread optional String Open this URL when project proofreading is complete. URL will be opened with "project" - project identifier and "language" - language code.
json optional String Könnte keinen Wert enthalten. Definiert, dass die Antwort im JSON-Format sein soll.
jsonp optional String Name der Rückruffunktion. Definiert, dass die Antwort im JSONP-Format sein soll.
Variablen
project-identifier String Projekt-ID.
login String Ihr Nutzername auf Crowdin.
account-key String Ihr Konto-API-Schlüssel.

Antwort

If the method is successful, it responds with an XML structure, as it is shown below (when 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>
</project>
Antwortbeispiel für Projekte mit "Moderate" 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>
</project>
Antwort-Beispiel bei Fehlschlag:
<?xml version="1.0" encoding="UTF-8"?>
<error>
  <code>3</code>
  <message>API key is not valid</message>
</error>

Beispiele

curl \
  -F "logo=@logo.png" \
  -F "name=new project name" \
  -F "description=new project description" \
  -F "cname=new.example.com" \
  -F "languages[]=de" \
  -F "languages[]=fr" \
  -F "languages[]=zh-CN" \
  -F "hide_duplicates=1" \
  -F "export_approved_only=0" \
  -F "public_downloads=1" \
  -F "qa_checks[enabled]=1" \
  https://api.crowdin.com/api/project/{project-identifier}/edit-project?login={username}&account-key={account-key}
<?php
$post_params = array();
$request_url = 'https://api.crowdin.com/api/project/{project-identifier}/edit-project?login={username}&account-key={account-key}';
$post_params['name'] = 'new project name';
$post_params['join_policy'] = 'open';
$post_params['languages[0]'] = 'fr';
$post_params['languages[1]'] = 'de';
$post_params['languages[2]'] = 'zh-CN';
$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;

War dieser Artikel hilfreich?