Using APIs (TMS)

Contenuti tradotti automaticamente dall'inglese con Phrase Language AI.

Questo è un semplice scenario API con chiamate API di esempio e istruzioni su come concatenarle per Completa un'azione semplice utilizzando solo le API. Le opzioni che possono essere impostate tramite le API sono ampie. Consultare le rispettive sezioni della documentazione API REST per saperne di più su tutte le opzioni disponibili.

La piattaforma API del postino è stata usata per creare lo scenario.

In questi esempi, l'URL di richiesta standard inizia con https://cloud.memsource.com. Nel caso in cui le API siano utilizzate da un'organizzazione nel data center statunitense, l'URL di richiesta deve iniziare con https://us.cloud.memsource.com.

Scenario

Autenticazione

L'utente è autenticato (l'equivalente API dell'accesso).
Creazione

Creazione di un progetto semplice, caricamento di lavori e assegnazione di traduttori con notifica e-mail.
Traduzione

Lavoro di traduzione eseguito al di fuori dello scenario API (in uno qualsiasi degli Editor).
Funzione API

Una volta terminato l'incarico (contrassegnato come Completato dal traduttore), lo stato del progetto è contrassegnato come Completato e il documento finito viene scaricato dal progetto.

Metodologia

Ogni singola chiamata API REST ha un metodo appropriato elencato. L'utilizzo di un metodo non corretto (ad esempio GET invece di POST nella chiamata alla creazione del progetto) provocava una chiamata API non riuscita.

Passaggio 1: Autenticazione

Esistono due metodi di autenticazione:

Chiamata API autenticazione:

Genera un token di autenticazione valido per 24 ore. Il token deve essere inserito in tutte le API seguenti. Il token convalida gli utenti e consente loro di eseguire qualsiasi altra funzione all'interno del profilo.
oAuth 2.0:

Consente la convalida di un'applicazione. Un'applicazione convalidata è in continua comunicazione con e non necessita di ulteriore autenticazione.

Per lo scenario viene utilizzata la chiamata API di autenticazione. Il token generato è obbligatorio per tutte le chiamate API successive e non è elencato nei parametri di esempio.

Usa l'API di accesso per l'autenticazione con i parametri necessari. In questo caso sono necessari nome utente e password.

Metodo

POST
Richiedi URL

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

Organo della richiesta:

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

Risposta

Token di autenticazione.

I membri di più organizzazioni TMS hanno lo stesso nome utente e password per più account. In questo caso, la userUid deve essere aggiunta al corpo della richiesta per specificare a quale organizzazione l'utente vuole accedere. Se non specificato, l'utente ha effettuato l’accesso all’account predefinito associato al nome utente e alla password specificati.

Passaggio 2: Creazione, importazione e assegnazione progetti

Creazione progetto

Usa la chiamata API Progetti per creare un progetto con i parametri obbligatori nome, sourceLang e targetLangs.

Metodo

POST
Richiedi URL

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

Organo della richiesta

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

Risposta

Project UID (e.g. KmtNyVlz1skQd2aMVEipp7)

È possibile creare un modello di progetto utilizzando la chiamata API Crea modello progetto con l’UID progetto dell’ultima chiamata.

Metodo

POST
Richiedi URL

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

Organo della richiesta

{
  "progetto": {
    "uid": "stringa"
  },
  "name": "stringa",
  "importSettings": {
    "uid": "stringa"
  },
  "useDynamicTitle": true,
  "dynamicTitle": "string"
}

Risposta

UID modello progetto (ad es. AmtNyVlz1skQd2aMVEipp8)

Il modo più efficiente di creare progetti è usare un modello di progetto. Usa Crea progetto dal modello con l'UID Modello progetto dall'ultima chiamata per creare un nuovo progetto basato sulle impostazioni del modello di progetto.

L'espressione {templateUid} funge da segnaposto nell'URL della richiesta in cui è inserito l'UID modello di progetto ottenuto.

Metodo

POST
Richiedi URL

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

Organo della richiesta

{
  "name": "stringa",
  "sourceLang": "string",
  "targetLangs": [
    "stringa"
  ],
  "workflowSteps": [
    {
      "ID": "stringa"
    }
  ],
  "dateDue": "2019-08-24T14:15:22Z",
  "note": "stringa",
  "cliente": {
    "ID": "stringa"
  },
  "businessUnit": {
    "ID": "stringa"
  },
  "dominio": {
    "ID": "stringa"
  },
  "subDomain": {
    "ID": "stringa"
  },
  "costCenter": {
    "ID": "stringa"
  }
}{
  "progetto": {
    "uid": "stringa"
  },
  "name": "stringa",
  "importSettings": {
    "uid": "stringa"
  },
  "useDynamicTitle": true,
  "dynamicTitle": "string"
}

Risposta

Project UID (e.g. BmtNyVlz1skQd2aMVEipp9)

Creazione di lavoro

Con l'UID progetto dell'ultima chiamata, è possibile aggiungere nuovi lavori direttamente nel progetto appena creato utilizzando Crea lavoro.

L'espressione {projectUid} funge da segnaposto nell'URL della richiesta in cui è inserito l'UID progetto ottenuto. Con la chiamata API Crea lavoro, le intestazioni della richiesta devono essere modificate in corrispondenza di quelle richieste da phrase (in altre chiamate, Postman aggiunge automaticamente intestazioni appropriate alla richiesta).

Tutti i parametri da importare devono essere inseriti in un'intestazione Memsource personalizzata.

L’intestazione Contenuto-Disposizione deve includere il nome del file in un formato predefinito al fine di elaborare correttamente la richiesta di importare.

Per importare un file di origine, vai al corpo, seleziona binario e appare l'opzione Seleziona file.

Metodo

POST
Richiedi URL

https://cloud.memsource.com/web/api2/v1/projects/KmtNyVlz1skQd2aMVEipp7/jobs
(Intestazione) Disposizione dei contenuti

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

{"targetLangs":["de","fr"]}
(Intestazione) Tipo di contenuto

applicazione/octet-stream
Risposta

UID lavoro (ad es. dOYgeXzAdAbj4xFjuEVZP2)

UID AsyncRequest

Usare Ottieni richiesta asincrona con l'UID AsyncRequest dalla chiamata Crea lavoro per controllare che il lavoro sia stato creato correttamente e che sia funzionale.

L'UID lavoro restituito è unico in ogni passaggio del flusso di lavoro del progetto. Pertanto, se il lavoro viene creato in un progetto con flusso di lavoro, la risposta restituisce un UID lavoro univoco per ogni passaggio del flusso di lavoro.

Le impostazioni riutilizzabili per importare possono essere configurate con la chiamata Crea impostazioni importare. Nella risposta viene visualizzato un UID di impostazione per importare che può essere utilizzato nella chiamata Crea lavoro.

Per assegnare fornitori al lavoro (a meno che non siano assegnati direttamente nella chiamata Crea lavoro) usare la chiamata Modifica lavoro.

L’ID del fornitore inserito nella chiamata può essere ottenuto in due modi:

Per recuperare l'ID dall'applicazione Phrase, segui i passaggi riportati di seguito:
1. Dalla pagina Impostazioni, scorri verso il basso fino alla sezione Amministrazione e fai clic su Utenti o fai clic su Utenti nella barra laterale.
  
  Si apre la pagina Utenti.
2. Fai clic sul cognome dell'utente e copia l'ultima parte dell'URL dal browser.
3. Usa questa parte come ID per quell'utente.
Usa l'elenco utenti.

Questa chiamata API non richiede parametri specifici e restituirà un elenco di tutti gli utenti nell'account. La risposta contiene sia nomi utente che ID.

È possibile aggiungere alla query un parametro facoltativo, userName, che consente di elencare solo gli utenti con nomi utente specifici.

Notifica agli utenti assegnati

L’ID lavoro può quindi essere utilizzato come parametro facoltativo nella chiamata Notifica utenti assegnati insieme al parametro e-mailmodel che rappresenta l’ID del modello di e-mail da utilizzare. Questo può essere ottenuto utilizzando l'elenco modelli e-mail.

Richiedi URL

https://cloud.memsource.com/web/api2/v1/projects/KmtNyVlz1skQd2aMVEipp7/jobs/notifyAssigned
Risposta

empty (stato 204: Nessun contenuto)

Qui è dove il traduttore inizierebbe a lavorare nel proprio profilo proprio come se venisse utilizzata l'interfaccia utente phrase. Al termine del lavoro, il PM incaricato riceve una notifica e viene avviata la parte Avanti dello scenario. Una richiamata può essere intercettata tramite webhook per avviare automaticamente la parte Avanti dello scenario, ma questo non sarà affrontato in questo esempio.

Passaggio 3: Scarica file tradotti (completati), imposta il progetto come completato

Scarica file tradotti

Questo scenario parte dal presupposto che un traduttore completi il proprio incarico (contrassegna il lavoro come Completato), ma il file completato può essere scaricato in qualsiasi momento, il lavoro non deve necessariamente avere lo stato Completato.

Per scaricare un file tradotto sono necessarie due chiamate API: Scarica file di destinazione (asincrono)e scarica file di destinazione.

Il primo passaggio è chiamare Scarica file destinazione (asincrono) con i parametri projectUid e jobUid. Se si scarica il file completato da un progetto con più passaggi del flusso di lavoro, assicurarsi di usare il jobUid dal passaggio del flusso di lavoro specifico da cui si desidera scaricare il file completato, ad esempio passaggio del flusso di lavoro revisione.

Per recuperare il jobUID per uno specifico passaggio del flusso di lavoro dall'applicazione Phrase, segui i passaggi riportati di seguito:
1. Apri il progetto.
2. Nella tabella Lavori, passare al passaggio del flusso di lavoro da cui scaricare il file completato.
3. Copiare la parte univoca dell'URL dopo /lavoro dal browser.
Usa la chiamata API Elenco lavori.

Questo endpoint restituisce un elenco di lavori all'interno del progetto specificato. Usare la chiamata con il parametro di query WorkflowLevel. Questo parametro è un parametro diverso da zero che indica il passaggio del flusso di lavoro a cui appartengono i lavori restituiti. Se non specificato, il suo valore è impostato su 1 (= primo passaggio del flusso di lavoro) per impostazione predefinita. Ad esempio, se è necessario ottenere i lavori dal passaggio di revisione, specificare il numero di tale passaggio nel parametro di query, ovvero 2.

La chiamata Scarica file di destinazione (asincrono) avvia una richiesta asincrona di generare e scaricare il file di destinazione contenente le traduzioni. Non fornisce direttamente il file di destinazione all'interno della risposta, ma un asyncRequestId richiesto per la chiamata successiva.

Metodo

PUT
Richiedi URL

https://cloud.memsource.com/web/api2/v2/projects/KmtNyVlz1skQd2aMVEipp7/jobs/dOYgeXzAdAbj4xFjuEVZP2/targetFile
Risposta

ID AsyncRequest

Usa Ottieni richiesta asincrona con asyncRequestID dalla risposta per controllare che la richiesta sia completata. Una volta completata la richiesta asincrona, puoi scaricare il file di destinazione utilizzando il file di destinazione scaricato basato sulla richiesta asincrona. L'asyncRequestId può essere utilizzato una sola volta. Una volta scaricato, l'asyncRequestId non può essere usato ulteriormente.

Metodo

SCARICA
Richiedi URL

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

Risposta binaria con il file completato

Imposta il progetto come completato

Per finalizzare il progetto una volta Completato il lavoro nel progetto, usare la chiamata Modifica stato progetto con i parametri obbligatori projectUid e stato per modificare lo stato dell’intero progetto in Completato. Questa modifica è manuale, ma se si utilizza l'automazione stato progetto, lo stato verrà modificato automaticamente. È anche possibile attendere un webhook e avviare altre azioni in base alla richiamata ricevuta.

Metodo

POST
Richiedi URL

https://cloud.memsource.com/web/api2/v1/projects/KmtNyVlz1skQd2aMVEipp7/setStatus
Organo della richiesta
```
{ "status": "COMPLETED"}
```
Risposta

empty (stato 204: Nessun contenuto)