Projekt bearbeiten

Ein Crowdin-Projekt bearbeiten.

Anfrage

Hinweis: Entweder die Kombination aus Projekt-ID und Projektschlüssel oder die Kombination aus Projekt-ID, Nutzername und Kontoschlüssel to pass to this endpoint.

POST https://api.crowdin.com/api/project/{Projektkennung}/edit-project?key={Projektschlüssel}
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. Acceptable values are:
  • open
  • private
language_access_policy optional String Defines how project members can access target languages. Acceptable values are:
  • „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. Acceptable values are:
  • 0: Zeigen – Übersetzer müssen jede Zeichenkette einzeln übersetzen
  • 1: Verstecken – alle Duplikate werden die selbe Übersetzung haben
  • 2: Zeigen, aber sie automatisch übersetzen
  • 3: Zeigen (empfohlen für Versionen) — Duplikate werden nur zwischen den Versionen versteckt
export_translated_only optional Bool. 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 Bool. If set to 1 only approved translations will be exported in resulted ZIP file. Acceptable values are: 1 or 0.
auto_translate_dialects optional Bool. Untranslated strings of dialect will be translated automatically in exported file, leveraging translations from main language. Acceptable values are: 1 or 0.
public_downloads optional Bool. Defines whether "Download" button visible to everyone on Crowdin webpages. Acceptable values are: 1 or 0.
use_global_tm optional Bool. 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 (Eine Übersicht aller QK-Parameter). 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”.
Hinweis! This option is available only for organization plans.
webhook_file_translated optional String Öffnet die URL, wenn eine der Projektdateien vollständig übersetzt wurde. Die URL wird mit den folgenden Parametern geöffnet: „project” - Projekt-ID, „language” - Sprachcode und „file” - Dateiname.
webhook_file_proofread optional String Öffnet die URL, wenn eine der Projektdateien vollständig genehmigt wurde. Die URL wird mit den folgenden Parametern geöffnet: „project” - Projekt-ID, „language” - Sprachcode und „file” - Dateiname.
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 May not contain value. Defines that response should be in JSON format.
jsonp optional String Callback function name. Defines that response should be in JSONP format.
Variablen
project-identifier String Projekt-ID.
project-key String Projekt-API-Schlüssel. Entweder project-key oder die Kombination aus login und account-key wird benötigt.
login String Ihr Crowdin-Nutzername. Entweder project-key oder die Kombination aus login und account-key wird benötigt.
account-key String Ihr Konto-API-Schlüssel. Entweder project-key oder die Kombination aus login und account-key wird benötigt.

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>
Response example for projects with "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>
Unsuccessful response sample:
<?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/{Projekt-ID}/edit-project?key={Projektschlüssel}
<?php
$post_params = array();
$request_url = 'https://api.crowdin.com/api/project/{project-identifier}/edit-project?key={project-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?