Phrase TMS-API

API Technology (TMS)

Inhalte werden von Phrase Language AI maschinell aus dem Englischen übersetzt.

Unsere API sieht Anwendungsentitäten (Projekte, Jobs, Einstellungen) als Ressourcen, die abgerufen, erstellt, geändert und gelöscht werden können. 

Jede HTTP-Methode stellt eine Aktion dar:

  • GET

    Ruft eine Ressource ab, ohne die Ressource zu ändern

  • POST

    Erstellt eine Ressource. Beiträge werden auch für Operationen Verwendet, die in keine der vier Operationen passen oder lange oder komplexe Eingaben haben – wie Suchen von Übersetzungen oder Erstellen von Jobs.

  • PUT

    Aktualisiert die Ressource. Bitte Hinweis, dass die gesamte Entität mit allen ihren Feldern erforderlich ist, nicht nur die geänderten. Wenn sie nicht berücksichtigt wird, bedeutet dies, dass sie Bis Null gesetzt werden sollte.

  • DELETE

    Entf die Ressource.

importieren

Eingabe- und Ausgabedaten liegen normalerweise im JSON-Formular vor. Für eine Datei als anfordernder Nachrichten Inhalt wird der Typ Anwendung/Oktett-Stream oder Mehrteiler/Formular-Daten Verwendet.

Unternehmen Verwendet möglichst eine flache Struktur Bis gute Reaktionszeiten erhalten bleiben. Anstelle ganzer untergeordneter Objekte in den Antworten werden Referenzen enthalten, die die ID, Uid und einige andere Attribute enthalten. Es werden entweder ID-Referenz- oder Uid-Referenz-Objekte Bis Bis zu verbundenen Entitäten erwartet.

Alle Listen sind seitenweise angelegt. Verwende die Parameter pageNumber und pageSize Bis zum Abruf der angeforderten Daten. Die maximale Seitengröße ist 50.

Dokumentation

OpenAPI 3.0 wird für API Dokumentation Verwendet. Für die Entwicklung beim Kunden werden Swagger-Codegeneratoren empfohlen.

Dateien der Rohdokumentation:

API Beispiele

Liste aller Übersetzungen erhalten

GET

/web/api2/v1/transMemories

Antwort

200

{
    "pageNumber": 0,
    "content": [
        {
            "internalId": 1,
            "createdBy": {
                "userName": "admin",
                "id": "3",
                "firstName": "Jan",
                "lastName": "Janocko",
                "role": „ADMIN“,
                "email": "jan.janocko@phrase.com"
            },
            "client": null,
            "Hinweis": "Nicht Bis zum Verwenden im TM erforderlich",
            "dateCreated": "2018-01-09T14:07:46+0000",
            "id": "1",
            "targetLangs": [
                „es“,
                "es"
            ],
            „Teilbereich“: null,
            "businessUnit": {
                "id": "1",
                "name": „First BU“
            },
            "sourceLang": "en",
            "Fachbereich": null,
            "name": "Mein neues TM"
        }
    ],
    "numberOfElements": 1,
    "totalElements": 1,
    "pageSize": 50,
    "totalPages": 1
}

Neues Translation Memory erstellen

POST

/web/api2/v1/transMemories

{{
"name": "Mein neues TM",
"sourceLang": "en",
"targetLangs": [
"es", "it-IT"
],
"businessUnit": {
"id": "1"
},
"Hinweis": "Nicht Bis zum Verwenden im TM erforderlich"
}

Antwort

201

{
    "internalId": 1,
    "createdBy": {
        "userName": "admin",
        "id": "3",
        "firstName": "J",
        "lastName": "Jan",
        "role": „ADMIN“,
        "email": "jan.j@phrase.com"
    },
    "client": null,
    "Hinweis": "Nicht Bis zum Verwenden im TM erforderlich",
    "dateCreated": "2018-01-09T14:07:46+0000",
    "id": "1",
    "targetLangs": [
        „es“,
        "es"
    ],
    „Teilbereich“: null,
    "businessUnit": {
        "id": "1",
        "name": „First BU“
    },
    "sourceLang": "en",
    "Fachbereich": null,
    "name": "Mein neues TM"
}

Dateien beim Erstellen eines Jobs hinzufügen

hinzufügen Sie diese Datei Bis Nachricht der Anforderung als binären Anhang hinzu. Stelle sicher, dass Phrase und die Inhalt-Disposition-Header korrekt einfügen sind.

Beispiel PHP vom Beitrag:

<?php

$request = new HttpRequest();
$request->setUrl(https://cloud.phrase.com/web/API2/v1/projects/%7BUID%20of%20your%20project%7D/Jobs);
$request->setMethod(HTTP_METH_POST);

$request->setQueryData(array(
Token => Dein Token geht hierhin
));

$request->setHeaders(array(
'postman-token' => 'ABC',
'cache-control' => 'no-cache',
'content-disposition' => 'filename*=UTF-8''Sample.txt',
'memsource => '{\\"targetLangs\\":[\\"de\",\\"fr\\",\\"es\\"],\\"callbackUrl\\":\\"https://my-shiny-service.com/consumeCallback\\",\\"importSettings\\":{\\"uid\\":\\"WF0T1SfSHxII09yKr0dZh9\\"}'
));

try {
$response = $request->send();

echo $response->getBody();
} CAT (HttpException $ex) {
echo $ex;
}

Fehler Handhabung

Wenn bei der Handhabung einer API-Anforderung ein Problem auftritt, wird die folgende JSON-Struktur zurück. Der Fehler Code wird immer vorhanden sein; die detaillierte Beschreibung kann null sein.

{ "errorCode": "Ungültige Argumente",
"errorDescription": "Das erforderliche Argument \"Passwort\" mit Typ \"Zeichenfolge\" Fehlt."
}

Eine Antwort auf einen Fehler kann erkannt werden, indem der HTTP Status der Antwort gelesen wird. Wenn ein Fehler auftritt, wird er niemals Bis 2xx gesetzt. Bei Authentifizierung oder Autorisierungsproblemen lautet der Status 400 Bad Request, 401 oder 403.

Probleme melden

Wenn ein Problem Bis zum technischen Support gemeldet wird, enthält der Bericht Folgendes:

  • API Endpunkt

  • Anforderung

  • Zeit (und Zeitzone)

  • Antwort

  • Phrase-Action-ID der Antwort

War dieser Beitrag hilfreich?

Sorry about that! In what way was it not helpful?

The article didn’t address my problem.
I couldn’t understand the article.
The feature doesn’t do what I need.
Other reason.

Note that feedback is provided anonymously so we aren't able to reply to questions.
If you'd like to ask a question, submit a request to our Support team.
Thank you for your feedback.