Using APIs (TMS)

Obsah je strojově přeložen z angličtiny s použitím Phrase Language AI.

Jedná se o jednoduchý scénář API se vzorovými voláními API a pokyny, jak je zřetězit dohromady, abyste Dokončili jednoduchou akci pouze s využitím API. Možnosti, které lze nastavit prostřednictvím API, jsou rozsáhlé. Další informace o všech dostupných možnostech naleznete v příslušných oddílech dokumentace REST API.

Scénář vytvořila platforma API Postman.

V těchto příkladech standardní URL požadavku začíná https://cloud.memsource.com. V případě, že organizace v datovém centru v USA používá API, měla by URL požadavku začínat https://us.cloud.memsource.com.

Scénář

Ověřování

Uživatel je ověřen (API ekvivalent přihlášení).
Vytvoření

Vytvoření jednoduchého projektu, nahrané zakázky a přiřazení překladatele s oznámením e-mailem.
Překlad

Překladové zakázky prováděné mimo scénář API (v libovolném editoru).
Funkce API

Po dokončení zadání (označení překladatelem jako dokončeno) je stav projektu nastaven na dokončeno a hotový dokument je stažen z projektu.

Metodika

Každé jednotlivé volání REST API má uvedenou vhodnou metodu. Použití nesprávné metody (např. GET namísto POST ve volání vytvoření projektu) vede k neúspěšnému volání API.

Fáze 1: Ověřování

Existují dva způsoby ověřování:

Volání API ověřování:

Generuje token pro ověřování platný 24 hodin. Token je třeba vložit do všech následujících API. Token ověřuje uživatele a umožňuje jim provádět všechny další funkce v profilu.
oAuth 2.0:

Umožňuje ověření žádosti. Ověřená aplikace s ní neustále komunikuje a nevyžaduje žádné další ověřování.

Pro scénář se použije volání Ověřování API. Vygenerovaný token je vyžadován pro všechna následující volání API a není uveden v příkladech parametrů.

Použijte API pro přihlašování pro ověřování s požadovanými parametry. V tomto případě je vyžadováno uživatelské jméno a heslo.

Metoda

POST
URL požadavku

https://cloud.memsource.com/web/api2/v3/auth/login

Subjekt žádosti:

{ "userName":"username", "password":"password"}

Odpověď

Ověřovací token.

Členové více organizací TMS mají stejné uživatelské jméno a heslo pro více účtů. V tomto případě musí být do subjektu požadavku přidáno userUid, které určí, ke které organizaci se chce uživatel přihlásit. Není-li zadáno, je uživatel přihlášen k výchozímu uživatelskému účtu spojenému se zadaným uživatelským jménem a heslem.

Fáze 2: Vytvoření, import a přiřazení projektu

Vytvoření projektu

Použijte volání API projektu a vytvořte projekt s názvem povinných parametrů, sourceLang a targetLangs.

Metoda

POST
URL požadavku

https://cloud.memsource.com/web/api2/v3/projects

Subjekt žádosti

{ "name":"My projekt", "sourceLang":"en", "targetLangs":[ "de","fr" ]}

Odpověď

UID projektu (např. KmtNyVlz1skQd2aMVEipp7)

Je možné vytvořit šablonu projektu pomocí API volání Vytvořit šablonu projektu s UID projektu z posledního volání.

Metoda

POST
URL požadavku

https://cloud.memsource.com/web/api2/v1/projectTemplates

Subjekt žádosti

{
  "project": {
    "uid": "řetězec"
  },
  "name": "řetězec",
  "importSettings": {
    "uid": "řetězec"
  },
  "useDynamicTitle": true,
  "dynamicTitle": "string"
}

Odpověď

UID šablony projektu (např. AmtNyVlz1skQd2aMVEipp8)

Nejefektivnější způsob vytváření projektů je použít šablonu projektu. Použijte Vytvořit projekt ze šablony s UID šablony projektu z poslední výzvy a vytvořte nový projekt na základě nastavení šablony projektu.

Výraz {templateUid} slouží jako zástupný znak v URL požadavku, kam se vloží získané UID šablony projektu.

Metoda

POST
URL požadavku

https://cloud.memsource.com/web/api2/v2/projects/applyTemplate/oNQiljwTGHpd2l1nnQRiu4

Subjekt žádosti

{
  "name": "řetězec",
  "sourceLang": "string",
  "targetLangs": [
    „řetězec“
  ],
  "workflowSteps": [
    {
      "id": "řetězec"
    }
  ],
  "dateDue": "2019-08-24T14:15:22Z",
  "note": "string",
  "client": {
    "id": "řetězec"
  },
  "businessUnit": {
    "id": "řetězec"
  },
  "doména": {
    "id": "řetězec"
  },
  "subDomain": {
    "id": "řetězec"
  },
  "costCenter": {
    "id": "řetězec"
  }
}{
  "project": {
    "uid": "řetězec"
  },
  "name": "řetězec",
  "importSettings": {
    "uid": "řetězec"
  },
  "useDynamicTitle": true,
  "dynamicTitle": "string"
}

Odpověď

UID projektu (např. BmtNyVlz1skQd2aMVEipp9)

Vytvoření zakázky

Pomocí UID projektu z poslední výzvy lze přidávat nové zakázky přímo do nově vytvořeného projektu pomocí funkce Vytvořit zakázku.

Výraz {projectUid} slouží jako zástupný znak v URL požadavku, kam se vloží získané UID projektu. S voláním Vytvořit zakázku API musí být záhlaví požadavku změněna ve shodě s těmi, které požaduje Phrase (v ostatních voláních pošta automaticky přidá do požadavku příslušná záhlaví).

Všechny parametry importu je třeba vložit do vlastní hlavičky Memsource.

Záhlaví Obsah-Dispozice musí obsahovat název souboru v předem definovaném formátu pro správné zpracování požadavku na import objednávky.

Pro import zdrojového souboru přejděte do jeho těla, vyberte binární soubor a zobrazí se možnost Vybrat soubor.

Metoda

POST
URL požadavku

https://cloud.memsource.com/web/api2/v1/projects/KmtNyVlz1skQd2aMVEipp7/jobs
(Záhlaví) Dispozice obsahu

filename*=UTF-8''file.txt
(Záhlaví) Memsource

{"targetLangs":["de","fr"]}
(Záhlaví) Typ obsahu

aplikace/oktet-stream
Odpověď

UID zakázky (např. dOYgeXzAdAbj4xFjuEVZP2)

UID AsyncRequest

Použijte Získat asynchronní požadavek s UID AsyncRequest z volání Vytvořit zakázku a zkontrolujte, zda byla zakázka úspěšně vytvořena a zda je funkční.

UID vrácené zakázky je unikátní v každé fázi pracovního postupu projektu. Pokud je tedy zakázka vytvořena v projektu s pracovním postupem, vrací odpověď pro každou fázi pracovního postupu jedinečné UID zakázky.

Znovu použitelné nastavení importu lze nakonfigurovat voláním Vytvořit nastavení importu. V odpovědi je uvedeno UID nastavení importu, které lze použít ve volání Vytvořit zakázku.

Chcete-li k zakázce přiřadit poskytovatele (pokud nejsou přiřazeni přímo ve volání Vytvořit zakázku), použijte volání Upravit zakázku.

ID poskytovatele vložené do volání lze získat dvěma způsoby:

ID z aplikace Phrase získáte takto:
1. Na stránce Nastavení přejděte dolů do oddílu Správa a klikněte na Uživatelé nebo klikněte na Uživatelé v postranním panelu.
  
  Otevře se stránka Uživatelé.
2. Klikněte na příjmení uživatele a zkopírujte poslední část adresy URL z prohlížeče.
3. Použijte tuto část jako ID pro daného uživatele.
Použijte volání API Seznam uživatelů.

Toto volání API nevyžaduje žádné konkrétní parametry a vrátí seznam všech uživatelů na uživatelském účtu. Odpověď obsahuje uživatelská jména i ID.

K dotazu lze přidat volitelný parametr userName, který vám umožní seznam pouze uživatelů s konkrétními uživatelskými jmény.

Upozornit přiřazené uživatele

UID zakázky pak lze použít jako volitelný parametr ve volání Oznámit přiřazeným uživatelům spolu s parametrem e-mail šablony představujícím ID šablony e-mailu, která se má použít. Toho lze dosáhnout pomocí volání Šablony e-mailu Seznamu.

URL požadavku

https://cloud.memsource.com/web/api2/v1/projects/KmtNyVlz1skQd2aMVEipp7/jobs/notifyAssigned
Odpověď

Empty (Stav 204: Žádný obsah)

To je místo, kde překladatel začne zakázku v jeho profilu, stejně jako by byl používán Phrase UI. Po dokončení zakázky obdrží odpovědný PM oznámení a spustí se Další část scénáře. Návrat lze zachytit prostřednictvím webhooků a automaticky zahájit Další část scénáře, ale to se v tomto příkladu nebude řešit.

Fáze 3: Stáhnout přeložený (Dokončit) soubor, nastavit projekt na dokončený

Stáhnout přeložený soubor

Tento scénář pracuje s předpokladem, že překladatel dokončí zadání (označí zakázku jako dokončenou), ale dokončený soubor lze kdykoli stáhnout, zakázka nemusí mít stav Dokončeno.

Chcete-li stáhnout přeložený soubor, potřebujete dvě volání API: Stáhnout soubor cíle (asynchronní) a stáhnout soubor cíle na základě volání asynchronních požadavků.

První fází je volání Stáhnout soubor cíle (asynchronní) s parametry projectUid a jobUid. Pokud stahujete hotový soubor z projektu s více fázemi pracovního postupu, použijte jobUid z konkrétní fáze pracovního postupu, ze které chcete hotový soubor stáhnout, např. fáze pracovního postupu revize.

Chcete-li získat jobUID pro konkrétní fázi pracovního postupu z aplikace Phrase, postupujte takto:
1. Otevřete projekt.
2. V tabulce Zakázky přejděte do fáze pracovního postupu, ze které chcete stáhnout hotový soubor.
3. Zkopírujte jedinečnou část adresy URL po /zakázce z prohlížeče.
Použijte volání API Seznam zakázek.

Tento koncový bod vrací seznam zakázek v zadaném projektu. Použijte volání s parametrem dotazu na úrovni pracovního postupu. Tento parametr je nenulový parametr, který označuje fázi pracovního postupu vrácených zakázek. Není-li zadáno, je jeho hodnota ve výchozím nastavení nastavena na 1 (= první fáze pracovního postupu). Pokud například potřebujete zakázky získat z fáze revize, zadejte v parametru dotazu číslo této fáze, tj. 2.

Volání Stáhnout soubor cíle (asynchronní) iniciuje asynchronní požadavek vygenerovat a stáhnout soubor cíle obsahující překlady. Neposkytuje přímo soubor cíle v odpovědi, ale asyncRequestId vyžadovaný pro následující volání.

Metoda

PUT
URL požadavku

https://cloud.memsource.com/web/api2/v2/projects/KmtNyVlz1skQd2aMVEipp7/jobs/dOYgeXzAdAbj4xFjuEVZP2/targetFile
Odpověď

ID AsyncRequest

Použijte Získat asynchronní požadavek s asyncRequestID z odpovědi a zkontrolujte, zda je požadavek dokončen. Po dokončení asynchronního požadavku můžete stáhnout soubor cíle pomocí souboru Stáhnout cíl na základě volání asynchronního požadavku. AsyncRequestId lze použít pouze jednou. Jakmile se stáhne, asyncRequestId se stává neplatným, aby se dal dále použít.

Metoda

GET
URL požadavku

https://cloud.memsource.com/web/api2/v2/projects/KmtNyVlz1skQd2aMVEipp7/jobs/dOYgeXzAdAbj4xFjuEVZP2/downloadTargetFile/1291716982
Odpověď

Binární odpověď s hotovým souborem

Nastavit projekt na dokončeno

Chcete-li projekt dokončit, jakmile se zakázka v projektu Dokončí, použijte volání Upravit stav projektu s povinnými parametry projectUid a stav a změňte stav celého projektu na Dokončeno. Tato změna je ruční, ale pokud se použije automatizace stavu projektu, změní se stav automaticky. Je také možné počkat na webhook a zahájit další akce na základě přijatého zpětného volání.

Metoda

POST
URL požadavku

https://cloud.memsource.com/web/api2/v1/projects/KmtNyVlz1skQd2aMVEipp7/setStatus
Subjekt žádosti
```
{ "status": "DOKONČENO"}
```
Odpověď

Empty (Stav 204: Žádný obsah)