Projekt részletei

Please consider that API 2.0 is now the preferred version to be used. The old API will remain fully functional until the end of 2021.

Crowdin API v2
Crowdin projekt részleteinek lekérdezése.

Kérelem

Note: Use the combination of project identifier, username, and account key to pass to this endpoint.

POST https://api.crowdin.com/api/project/{project-identifier}/info?login={username}&account-key={account-key}

Paraméterek

Név Érték Leírás
xml opcionális string Nem tartalmazhat értéket. Meghatározza, hogy a válasz XML formátumban legyen.
json opcionális string Nem tartalmazhat értéket. Meghatározza, hogy a válasz JSON formátumban legyen.
jsonp opcionális string Visszahívási függvény neve. Meghatározza, hogy a válasz JSONP formátumban legyen.
Változók
project-identifier string Projekt azonosítója.
login string A felhasználóneve a Crowdinban.
account-key string A fiókja API kulcsa.

Válasz

Ha sikeres, akkor ez a módszer XML struktúrát ad vissza, ahogy az az alábbiakban látható.
<?xml version="1.0" encoding="UTF-8"?>
<info>
  <languages> <!-- all project languages -->
    <item>
    <name>French</name>
    <code>fr</code>
    </item>
    <item>
    <name>Spanish</name>
    <code>es-ES</code>
    </item>
  </languages>
  <files> <!-- project files details -->
    <item>
    <node_type>directory</node_type>
    <id>1</id>
    <name>test</name>
    <files>
      <item>
        <node_type>file</node_type>
        <id>2</id>
        <name>market-info.txt</name>
        <created>2017-05-19T13:08:13+0000</created>
        <last_updated>2017-05-20T18:02:13+0000</last_updated>
        <last_accessed>2017-05-21T09:10:48+0000</last_accessed>
        <last_revision>1</last_revision>
      </item>
      <item>
        <node_type>file</node_type>
        <id>3</id>
        <name>strings.xml</name>
        <created>2017-05-19T13:38:15+0000</created>
        <last_updated>2017-05-20T18:42:11+0000</last_updated>
        <last_accessed>0000-00-00 00:00:00</last_accessed>
        <last_revision>1</last_revision>
      </item>
    </files>
    </item>
    <item>
      <node_type>file</node_type>
      <id>4</id>
      <name>strings.xml</name>
      <created>2017-05-19T13:40:09+0000</created>
      <last_updated>2017-05-21T06:31:48+0000</last_updated>
      <last_accessed>2017-05-21T07:21:01+0000</last_accessed>
      <last_revision>1</last_revision>
    </item>
  </files>
  <details> <!-- project details -->
    <source_language>
      <name>English</name>
      <code>en</code>
    </source_language>
    <name>test-project</name>
    <identifier>test-project</identifier>
    <created>2017-05-19T13:40:52+0000</created>
    <description>projekt leírása</description>
    <join_policy>open</join_policy>
    <last_build>2017-05-20T20:01:18+0000</last_build>
    <last_activity>2017-05-21T09:10:48+0000</last_activity>
    <total_strings_count>438</total_strings_count>
    <total_words_count>4238</total_words_count>
    <duplicate_strings_count>228</duplicate_strings_count>
    <duplicate_words_count>2249</duplicate_words_count>
    <participants_count>4</participants_count>
    <logo_url>https://dvsyjmyregmxp.cloudfront.net/images/project-logo/14d5d32996cfcc6473ebe7fe2c9f3152105.png</logo_url>
    <invite_url>
      <item>
        <language>Ukrainian</language>
        <translator>
          https://crowdin.com/project/test-project/invite?d=d5l6k4h685v6p483v6q4r44303
        </translator>
        <proofreader>
          https://crowdin.com/project/test-project/invite?d=95l625i6r4v6p483v6q4r44303
        </proofreader>
      </item>
    </invite_url>
  </details>
</info>

Figyelem!

last_updated mező jelzi a fájl utolsó frissítését és last_accessed jelzi az utolsó aktivitást a fájlban (p l. egy javaslat benyújtása). Ha nem volt olyan tevékenység, mint a last_build, last_activity vagy last_updated, a dátumok a következő formátumban jelennek meg: 0000-00-00T00: 00: 00 + 0000 UTC.
Ha a nyelv hozzáférési irányelv "Nyitott" a meghívó URL szakasz így néz ki:
<?xml version="1.0" encoding="UTF-8"?>
<invite_url>
  <translator>
    https://crowdin.com/project/test-project/invite
  </translator>
  <proofreader>
    https://crowdin.com/project/test-project/invite?d=95l625i6r4v6p483v6q4r44303
  </proofreader>
</invite_url>
Sikertelen válasz példa:
<?xml version="1.0" encoding="UTF-8"?>
<error>
  <code>3</code>
  <message>API key is not valid</message>
</error>

Példák

curl https://api.crowdin.com/api/project/{project-identifier}/info?login={username}&account-key={account-key}&jsonp=mycallback
<?php
$request_url = 'https://api.crowdin.com/api/project/{project-identifier}/info?login={username}&account-key={account-key}&xml';

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

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

echo $result;

Hasznos volt ez a cikk?