Using APIs (TMS)

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

Il s'agit d'un scénario API simple avec des exemples d'appels API et des instructions sur la façon de les enchaîner pour Terminer une action simple en utilisant uniquement des API. Les options qui peuvent être définies via les API sont nombreuses. Consultez les sections respectives de la documentation REST API pour en savoir plus sur toutes les options disponibles.

La plateforme API Postman a été utilisée pour créer le scénario.

Dans ces exemples, l'adresse URL de requête standard commence par https://cloud.memsource.com. En cas d’utilisation d’API par une organisation dans le centre de données américain, l’adresse URL de la demande doit commencer par https://us.cloud.memsource.com.

Scenario

Authentification

L'utilisateur est authentifié (l'équivalent API de la connexion).
Création

La création d’un projet simple, des tâches téléversées et de l’assignation linguiste avec notification e-mail.
Translation

Travail de traduction effectué en dehors du scénario API (dans n'importe lequel des éditeurs).
Fonction API

Une fois l'assignation terminée (marquée comme terminée par le linguiste), le statut du projet est défini sur Terminée et le document terminé est téléchargé à partir du projet.

Méthodologie

Chaque appel API REST individuel est associé à une méthode appropriée répertoriée. L'utilisation d'une méthode incorrecte (par exemple GET au lieu de POST dans l'appel de création du projet) entraîne un appel API infructueux.

Étape 1 : Authentification

Il existe deux méthodes d'authentification :

Authentification API call :

Génère un jeton d'authentification valable 24 heures. Le jeton doit être inséré dans toutes les API suivantes. Le jeton valide les utilisateurs et leur permet d'effectuer toutes autres fonctions au sein du profil.
oAuth 2.0 :

Permet la validation d'une application. Une application validée est en communication continue avec et n'a besoin d'aucune authentification supplémentaire.

Pour le scénario, l'appel API Authentification est utilisé. Le jeton généré est requis pour tous les appels API suivants et n'est pas listé dans des exemples de paramètres.

Utilisez l'API de connexion pour l'authentification avec les paramètres requis. Dans ce cas, le nom d'utilisateur et le mot de passe sont requis.

Méthode

POST
Requête URL

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

Organe de requête :

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

Réponse

Jeton d’authentification.

Les membres de plusieurs organisations TMS ont le même nom d'utilisateur et le même mot de passe pour plusieurs comptes. Dans ce cas, l'identifiant utilisateur doit être ajouté au corps de la demande pour spécifier à quelle organisation l'utilisateur souhaite se connecter. S'il n'est pas spécifié, l'utilisateur est connecté au compte par défaut associé au nom d'utilisateur et au mot de passe donnés.

Étape 2 : Création, importer et assignation de projet

Projet Creation

Utilisez l'appel API projets pour créer un projet avec les paramètres obligatoires name, sourceLang et targetLangs.

Méthode

POST
Requête URL

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

Corps de demande

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

Réponse

Project UID (e.g. KmtNyVlz1skQd2aMVEipp7)

Il est possible de créer un modèle projet en utilisant l'appel API Créer modèle projet avec l'UID projet du dernier appel.

Méthode

POST
Requête URL

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

Corps de demande

{
  "projet": {
    "uid": "chaîne"
  },
  "name": "chaîne",
  "importSettings": {
    "uid": "chaîne"
  },
  "useDynamicTitle": true,
  "dynamicTitle": "string"
}

Réponse

UID modèle projet (par exemple AmtNyVlz1skQd2aMVEipp8)

Le moyen le plus efficace de créer des projets est d'utiliser un modèle projet. Utiliser Créer projet depuis modèle avec l'UID modèle projet du dernier appel pour créer un nouveau projet basé sur les paramètres du modèle projet.

L ' expression {templateUid} sert d ' espace réservé dans l ' adresse URL de la demande où l ' UID de modèle projet obtenu est inséré.

Méthode

POST
Requête URL

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

Corps de demande

{
  "name": "chaîne",
  "sourceLang": "chaîne",
  "targetLangs": [
    "chaîne"
  ],
  « étapes de flux » : [
    {
      "Identifiant": "chaîne"
    }
  ],
  "dateDue": "2019-08-24T14:15:22Z",
  "note" : "chaîne",
  "client": {
    "Identifiant": "chaîne"
  },
  "businessUnit": {
    "Identifiant": "chaîne"
  },
  "domaine": {
    "Identifiant": "chaîne"
  },
  « sous-domaine » : {
    "Identifiant": "chaîne"
  },
  "costCenter": {
    "Identifiant": "chaîne"
  }
}{
  "projet": {
    "uid": "chaîne"
  },
  "name": "chaîne",
  "importSettings": {
    "uid": "chaîne"
  },
  "useDynamicTitle": true,
  "dynamicTitle": "string"
}

Réponse

UID projet (par exemple BmtNyVlz1skQd2aMVEipp9)

Tâches

Avec l'UID du projet du dernier appel, de nouvelles tâches peuvent être ajoutées directement dans le projet nouvellement créé en utilisant Créer tâche.

L ' expression {Uid de projet} sert d ' espace réservé dans l ' adresse URL de la demande où l ' UID de projet obtenu est inséré. Avec l'appel API Créer tâche, il faut changer les en-têtes de la demande en correspondance avec ceux requis par Phrase (dans les autres appels, le facteur ajoute automatiquement les en-têtes appropriés à la demande).

Tous les paramètres importer doivent être insérés dans un en-tête Memsource personnalisé.

L ' en-tête < < Disposition du contenu > > doit inclure le nom du fichier dans un format prédéfini aux commandes pour traiter correctement la demande d ' importer.

Pour importer un fichier source, allez dans le corps, sélectionnez binaire et l'option Sélectionner fichier apparaît.

Méthode

POST
Requête URL

https://cloud.memsource.com/web/api2/v1/projects/KmtNyVlz1skQd2aMVEipp7/jobs
(En-tête) Disposition du contenu

filename*=UTF-8''file.txt
(Header) Memsource

{"targetLangs":["de","fr"]}
(En-tête) Type de contenu

application/octet-stream
Réponse

Job UID (e.g. dOYgeXzAdAbj4xFjuEVZP2)

UID de demande asynchrone

Utilisez Obtenir une demande asynchrone avec l'UID AsyncRequest de l'appel Créer tâche pour vérifier que la tâche a été créée avec succès et qu'elle est fonctionnelle.

L'UID de tâche renvoyé est unique à chaque étape du flux de travail du projet. Par conséquent, si la tâche est créée dans un projet avec flux de travaux, la réponse retourne un UID de tâche unique pour chaque étape du flux de travaux.

Les paramètres importer réutilisables peuvent être configurés avec l'appel Créer importer paramètres. Un UID de paramètre importer qui peut être utilisé dans l'appel créer tâche est reçu dans la réponse.

Pour assigner des prestataires à la tâche (sauf si assigné directement dans l'appel Créer tâche) utilisez l'appel Modifier tâche .

L'Identifiant du fournisseur inséré dans l'appel peut être obtenu de deux manières :

Pour récupérer l'Identifiant de l'application Phrase, procédez comme suit:
1. Dans la page Paramètres, faites défiler vers le bas jusqu'à la section Administration et cliquez sur Utilisateurs ou cliquez sur Utilisateurs dans la barre latérale.
  
  La page Utilisateurs s'ouvre.
2. Cliquez sur le nom de famille de l'utilisateur et copiez la dernière partie de l'adresse URL depuis le navigateur.
3. Utiliser cette partie comme Identifiant de cet utilisateur.
Utilise l'appel API Liste utilisateurs.

Cet appel API ne nécessite aucun paramètre spécifique, et il renverra une liste de tous les utilisateurs du compte. La réponse contient à la fois des noms d'utilisateur et des identifiants.

Un paramètre facultatif, userName, peut être ajouté à la requête vous permettant de lister uniquement les utilisateurs avec des noms d'utilisateur spécifiques.

Notifier les utilisateurs assignés

La tâche Identifiant U peut ensuite être utilisée comme paramètre facultatif dans l'appel Notifier les utilisateurs assignés avec le paramètre e-mail Modèle représentant l'identifiant du modèle e-mail à utiliser. Cette information peut être obtenue en utilisant Liste e-mail modèles call.

Requête URL

https://cloud.memsource.com/web/api2/v1/projects/KmtNyVlz1skQd2aMVEipp7/jobs/notifyAssigned
Réponse

Empty (statut 204 : Aucun contenu)

C'est là que le traducteur commençait le travail dans son profil comme si l'interface utilisateur Phrase était utilisée. Une fois la tâche terminée, le PM responsable reçoit une notification et la partie Suivante du scénario est lancée. Un rappel peut être intercepté au moyen de webhooks pour lancer automatiquement la partie Suivante du scénario, mais cette question ne sera pas abordée dans cet exemple.

Étape 3: Télécharger le fichier traduit (terminé), passer le projet sur Terminé

Télécharger fichier traduit

Ce scénario part de l ' hypothèse qu ' un traducteur termine sa tâche (marque la tâche comme terminée), mais que le fichier terminé peut être téléchargé à tout moment, la tâche n ' ayant pas besoin d ' avoir le statut Terminé.

Pour télécharger un fichier traduit, deux appels API sont nécessaires : Téléchargez fichier cible (asynchrone) et téléchargez fichier cible basé sur les appels de demande asynchrones.

La première étape consiste à appeler Télécharger fichier cible (asynchrone) avec les paramètres projectUid et jobUid . Si vous téléchargez le fichier terminé à partir d'un projet avec plusieurs étapes de flux de travaux, assurez-vous d'utiliser le jobUid à partir de l'étape du flux de travail spécifique à partir de laquelle vous souhaitez télécharger le fichier terminé, par exemple étape du flux de travail de révision.

Pour récupérer le jobUID pour une étape du flux de travail spécifique à partir de l'application Phrase, procédez comme suit:
1. Ouvrir le projet
2. Dans le tableau Tâches, passez à l'étape du flux de travail à partir de laquelle vous souhaitez télécharger le fichier terminé.
3. Copier la partie unique de l'adresse URL après / tâche depuis le navigateur.
Utilise l'appel API Liste jobs.

Ce point de terminaison renvoie une liste des tâches du projet spécifié. Utilisez l'appel avec le paramètre de requête WorkflowLevel . Ce paramètre est un paramètre non nul qui indique l'étape du flux de travail à laquelle appartiennent les tâches renvoyées. Si non spécifiée, sa valeur est définie sur 1 (= première étape du flux de travail) par défaut. Par exemple, si vous devez obtenir les tâches à partir de l'étape de révision, spécifiez le numéro de cette étape dans le paramètre requête, c'est-à-dire 2.

L'appel Télécharger fichier cible (asynchrone) lance une requête asynchrone pour générer et télécharger le fichier cible contenant des traductions. Il ne fournit pas directement le fichier cible dans la réponse mais un identifiant asynchrone requis pour l'appel suivant.

Méthode

PUT
Requête URL

https://cloud.memsource.com/web/api2/v2/projects/KmtNyVlz1skQd2aMVEipp7/jobs/dOYgeXzAdAbj4xFjuEVZP2/targetFile
Réponse

Identifiant AsyncRequest

Utilisez Obtenir une demande asynchrone avec l'asyncRequestID de la réponse pour vérifier que la demande est terminée. Une fois la requête asynchrone terminée, vous pouvez télécharger le fichier cible à l'aide du fichier Télécharger fichier cible basé sur l'appel de requête asynchrone. L'asyncRequestId ne peut être utilisé qu'une seule fois. Une fois téléchargé, l ' identifiant asyncRequestId ne sera plus utilisé.

Méthode

Télécharger
Requête URL

https://cloud.memsource.com/web/api2/v2/projects/KmtNyVlz1skQd2aMVEipp7/jobs/dOYgeXzAdAbj4xFjuEVZP2/downloadTargetFile/1291716982
Réponse

Réponse binaire avec le fichier terminé lui-même

Définir le projet comme terminé

Pour finaliser le projet une fois la tâche dans le projet Terminée, utilisez l'appel Modifier statut projet avec les paramètres obligatoires id de projet et statut pour modifier le statut du projet entier sur Terminé. Il s ' agit d ' une modification manuelle, mais si l ' automatisation statut projet est utilisée, le statut sera automatiquement modifié. Il est également possible d'attendre un webhook et de lancer d'autres actions en fonction du rappel reçu.

Méthode

POST
Requête URL

https://cloud.memsource.com/web/api2/v1/projects/KmtNyVlz1skQd2aMVEipp7/setStatus
Corps de demande
```
{ "status": « TERMINÉE »}
```
Réponse

Empty (statut 204 : Aucun contenu)