API Phrase TMS

Tecnologia API (TMS)

Contenuti tradotti automaticamente dall'inglese con Phrase Language AI.

La nostra API considera le entità applicazione (progetti, lavori, Impostazioni) come risorse che possono essere recuperate, create, modificate ed eliminate. 

Ogni metodo HTTP rappresenta un'azione:

  • GET

    Recupera una risorsa, senza cambiare mai la risorsa

  • POST

    Crea una risorsa. post viene Usare anche per operazioni che non rientrano in nessuna delle quattro operazioni o hanno input lunghi o complessi, come la Cerca di memorie di Traduzione o la creazione di lavoro.

  • PUT

    Aggiorna la risorsa. Nota che l'intera entità è obbligatoria con tutti i suoi campi, non solo quelli modificati; non includerla significa che dovrebbe essere impostata A null.

  • DELETE

    Canc la risorsa.

Importa

I dati di input e output sono solitamente in Modulo JSON, codificato UTF-8. Per un file come Tipo di contenuto Corpo richiesta viene Usato application/octet-stream o multipart/Modulo-dati.

Le entità Usano una struttura piatta quando possibile A mantenere buoni tempi di risposta. Invece di includere interi oggetti secondari nelle risposte, vengono contenuti riferimenti che contengono ID, UID e pochi altri attributi. Sono attesi oggetti IDReference o UidReference A riferimento A entità correlate.

Tutti gli Elenchi risposte sono impaginati. Usare i Parametri pageNumber e pageSize A recuperare i dati richiesti. La dimensione massima della pagina è 50.

Documentazione

OpenAPI 3.0 viene Usare per la documentazione API. I generatori di codice sono consigliati per lo sviluppo cliente.

File di documentazione grezzi:

Esempi API

Ottieni l'Elenco di tutte le memorie di Traduzione

GET

/web/api2/v1/transMemories

Risposta

200

{
    "pageNumber": 0,
    "contenuto": [
        {
            "internalId": 1,
            "creare": {
                "Usare": "Admin",
                "id": "3",
                "firstName": "Jan",
                "lastName": "Janocko",
                "role": "ADMIN",
                "email": "jan.janocko@phrase.com"
            },
            "cliente": null,
            "nota": "non necessaria A Usare nella TM",
            "dateCreated": "2018-01-09T14:07:46+0000",
            "id": "1",
            "targetLangs": [
                "es",
                "it"
            ],
            "sottodominio": null,
            "businessUnit": {
                "id": "1",
                "nome": "Prima BU"
            },
            "origine": "en",
            "dominio": null,
            "nome": "La mia nuova TM"
        }
    ],
    "numberOfElements": 1,
    "totalElements": 1,
    "pageSize": 50,
    "totalPages": 1
}

Creare nuova una memoria di traduzione

POST

/web/api2/v1/transMemories

{{
"nome": "La mia nuova TM",
"origine": "en",
"targetLangs": [
"es", "it-IT"
],
"businessUnit": {
"id": "1"
},
"nota": "non necessario A Usare nella TM"
}

Risposta

201

{
    "internalId": 1,
    "creare": {
        "Usare": "Admin",
        "id": "3",
        "firstName": "J",
        "lastName": "Jan",
        "role": "ADMIN",
        "E-mail": "jan.j@phrase.com"
    },
    "cliente": null,
    "nota": "non necessaria A Usare nella TM",
    "dateCreated": "2018-01-09T14:07:46+0000",
    "id": "1",
    "targetLangs": [
        "es",
        "it"
    ],
    "sottodominio": null,
    "businessUnit": {
        "id": "1",
        "nome": "Prima BU"
    },
    "origine": "en",
    "dominio": null,
    "nome": "La mia nuova TM"
}

Aggiunta file durante la creazione di un lavoro

aggiungere questo file A Corpo della richiesta come Allegato binario. Assicurati che Phrase e le intestazioni contenutoDisposition siano inserire correttamente.

Esempio PHP dal post:

<?php

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

$request->setQueryData(array(
'token' => 'Il tuo token va qui'
));

$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\"}}'
));

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

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

Gestione errori

In caso di problema nella gestione di una richiesta API, tornerà la seguente struttura JSON. Il codice di errore sarà sempre presente; la descrizione dettagliata potrebbe essere nulla.

{ "errorCode": "InvalidArguments",
"errorDescription": "Manca l'argomento richiesto \"password\" di Tipo \"stringa\".
}

Una risposta di errore può essere rilevata leggendo il codice di errore dello stato HTTP della risposta. Se si verifica un errore, non sarà mai impostato A 2xx. Il codice di stato è 400 bad request, 401 o 403 per problemi di Autenticazione o autorizzazione.

Segnalazione di problemi

Quando si riferisce il problema All’assistenza tecnica, include quanto segue nella relazione:

  • Endpoint API

  • Richiesta

  • Ora (e fuso orario)

  • Risposta

  • Phrase-Action-ID della risposta

Questo articolo ti è stato utile?

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.