Phrase TMS API

Technologie API (TMS)

Le contenu est traduit de l’anglais par Phrase Language AI.

Notre API considère les entités applicatives (projets, tâches, Paramètres) comme des ressources qui peuvent être récupérées, créées, modifiées et supprimées. 

Chaque méthode HTTP représente une action :

  • GET

    Récupère une ressource, sans jamais la modifier

  • POST

    Crée une ressource. POST est également Utilisé pour les opérations qui ne correspondent à aucune des quatre opérations ou dont la saisie est longue ou complexe, comme chercher des mémoires de Traduction ou créer des tâches.

  • PUT

    Mise à jour de la ressource. Veuillez note que l'entité entière est requise avec tous ses champs, pas seulement ceux modifiés ; ne pas l'inclure signifie qu'elle doit être définie À nullité.

  • SUPPRIMER

    Suppr. la ressource.

Important

Les données d'entrée et de sortie sont généralement au Forme JSON, codées UTF-8. Pour un fichier comme contenu Corps de requête Type application/octet-stream ou multipart/Forme-data est Utilisé.

Les entités Utilisent une structure plate lorsque cela est possible À maintenir de bons temps de réponse. Au lieu d'inclure des objets enfants entiers dans les réponses, les références contenant l'identifiant, identifiant unique et quelques autres attributs sont contenues. Les objets IDReference ou UidReference À référer Aux entités connexes sont attendus.

Toutes les Listes de réponses sont paginées. Utilisez les Paramètres pageNumber et pageSize À récupérer les données demandées. La taille de page maximale est de 50.

Documentation

OpenAPI 3.0 est Utilisé pour la documentation API. Des générateurs de code sont recommandés pour le développement client.

Fichiers documentation brute :

API Examples

Obtenir la Liste de toutes les mémoires de Traduction

GET

/web/API2/v1/transMemories

Réponse

200

{
    "pageNumber": 0,
    "content": [
        {
            "internalId": 1,
            "createdBy": {
                "userName": "admin",
                "id": "3",
                "firstName": "Jan",
                "lastName": "Janocko",
                "role": "ADMIN.",
                "email": "jan.janocko@phrase.com"
            },
            "client": null,
            "note": "pas nécessaire À Utiliser en MT",
            "dateCreated": "2018-01-09T14:07:46+0000",
            "id": "1",
            "targetLangs": [
                "es",
                "it"
            ],
            "sous-domaine": null,
            "businessUnit": {
                "id": "1",
                "name": "Première BU"
            },
            "sourceLang": "en",
            "domaine": null,
            "name": "Ma nouvelle MT"
        }
    ],
    "numberOfElements": 1,
    "totalElements": 1,
    "pageSize": 50,
    "totalPages": 1
}

Créer nouveau une mémoire de traduction

POST

/web/API2/v1/transMemories

{{
"name": "Ma nouvelle MT",
"sourceLang": "en",
"targetLangs": [
"es", "it-IT"
],
"businessUnit": {
"id": "1"
},
"note": "pas nécessaire À Utiliser en MT"
}

Réponse

201

{
    "internalId": 1,
    "createdBy": {
        "userName": "admin",
        "id": "3",
        "firstName": "J",
        "lastName": "Jan",
        "role": "ADMIN.",
        "email": "jan.j@phrase.com"
    },
    "client": null,
    "note": "pas nécessaire À Utiliser en MT",
    "dateCreated": "2018-01-09T14:07:46+0000",
    "id": "1",
    "targetLangs": [
        "es",
        "it"
    ],
    "sous-domaine": null,
    "businessUnit": {
        "id": "1",
        "name": "Première BU"
    },
    "sourceLang": "en",
    "domaine": null,
    "name": "Ma nouvelle MT"
}

Ajouter fichiers lors de la création d'une tâche

Ajouter ce fichier Au Corps de la demande sous forme de Pièce jointe binaire. Assurez-vous que Phrase et les en-têtes de disposition de contenu sont correctement insérés.

Exemple de PHP de post :

<?php

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

$request->setQueryData(array(
Authentifiant => Votre authentifiant passe ici
));

$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();
} TAO (HttpException $ex) {
echo $ex;
}

Traitement des erreurs

En cas de problème lors du traitement d'une demande API, la structure JSON suivante sera de retour. Le code erreur sera toujours présent; la description détaillée peut être nulle.

{ "errorCode": "InvalidArguments",
"errorDescription": "Argument obligatoire \"mot de passe\" de Type \"chaîne\" est Manquant."
}

Une réponse erreur peut être détectée en lisant l'état HTTP code de la réponse. Si une erreur survient, elle ne sera jamais définie À 2xx. Le code d'état est 400 mauvaise requête, 401 ou 403 pour les problèmes d'Authentification ou d'autorisation.

Rapporter les problèmes

Lorsqu'un problème est signalé À l'assistance technique, inclure les éléments suivants :

  • Point de terminaison API

  • Demande

  • Heure (et fuseau horaire)

  • Réponse

  • Identifiant Phrase Action de la réponse

Cet article vous a-t-il été 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.