Using APIs (TMS)

El contenido se traduce automáticamente del inglés por Phrase Language AI.

Este es un escenario API simple con llamadas API muestra e instrucciones sobre cómo encadenarlas para Completar una acción simple utilizando solo API. Las opciones que se pueden establecer a través de las API son amplias. Consulte las secciones respectivas de la documentación REST API para obtener más información sobre todas las opciones disponibles.

Se utilizó la plataforma API Postman para crear el escenario.

En estos ejemplos, la URL de solicitud estándar comienza con https://cloud.memsource.com. En caso de que una organización utilice API en el centro de datos estadounidense, la URL de la solicitud debe empezar con https://us.cloud.memsource.com.

Escenario

Autenticación

El usuario está autenticado (el equivalente API de iniciar sesión).
Creación

La creación de un proyecto simple, trabajos cargados y asignación lingüista con notificación por correo electrónico.
Traducción

Trabajos de traducción realizados fuera del escenario API (en cualquiera de los Editores).
Función API

Una vez terminada la asignación (marcada como Terminada por lingüista), el estado del proyecto se cambia a Terminada y el documento terminado se descarga del proyecto.

Metodología

Cada llamada REST API tiene un método apropiado en la lista. El uso de un método incorrecto (p. ej., GET en lugar de POST en la llamada de creación del proyecto) da lugar a una llamada API fallida.

Paso 1: Autenticación

Hay dos métodos de autenticación:

Autenticación API llamada:

Genera un identificador único (token) de autenticación válido durante 24 horas. El identificador único (token) debe insertarse en todas las API siguientes. El identificador único (token) valida a los usuarios y les permite realizar cualquier otra función dentro del perfil.
oAuth 2.0:

Permite la validación de una aplicación. Una aplicación validada está en comunicación continua con y no necesita más autenticación.

Para el escenario, se utiliza la llamada API autenticación. El identificador único (token) generado es necesario para todas las llamadas API posteriores y no se enumera en los parámetros de ejemplo.

Usa la API de inicio de sesión para autenticación con los parámetros requeridos. En este caso, se requiere nombre de usuario y contraseña.

Método

POST
Solicitar URL

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

Organismo solicitante:

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

Respuesta

Identificador único (token) de autenticación.

Los miembros de varias organizaciones del TMS tienen el mismo nombre de usuario y contraseña para varias cuentas. En este caso, debe añadirse el userUid al órgano de solicitud para especificar a qué organización desea acceder el usuario. Si no se especifica, el usuario inicia sesión en la cuenta predeterminada asociada con el nombre de usuario y la contraseña dados.

Paso 2: Creación, importar y asignación de proyecto

Creación de proyectos

Usa la llamada API Projects para crear un proyecto con los parámetros obligatorios name, sourceLang y targetLangs.

Método

POST
Solicitar URL

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

Organismo de solicitud

{ "name":"Mi proyecto", "sourceLang":"en", "targetLangs":[ "de","fr" ]}

Respuesta

UID del proyecto (p. ej., KmtNyVlz1skQd2aMVEipp7)

Es posible crear una plantilla del proyecto utilizando la llamada API Crear plantilla del proyecto con el UID del proyecto de la última llamada.

Método

POST
Solicitar URL

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

Organismo de solicitud

{
  "proyecto": {
    "uid": "cadena"
  },
  "name": "cadena",
  "importSettings": {
    "uid": "cadena"
  },
  "useDynamicTitle": true,
  "dynamicTitle": "string"
}

Respuesta

UID plantilla proyecto (p. ej., AmtNyVlz1skQd2aMVEipp8)

La forma más eficiente de crear proyectos es usar una plantilla del proyecto. Usar Crear proyecto desde plantilla con el UID de la plantilla del proyecto de la última llamada para crear un nuevo proyecto basado en la configuración de la plantilla del proyecto.

La expresión {templateUid} sirve como marcador de posición en la URL de solicitud donde se inserta el UID de plantilla del proyecto obtenido.

Método

POST
Solicitar URL

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

Organismo de solicitud

{
  "name": "cadena",
  "sourceLang": "cadena",
  "targetLangs": [
    "cadena"
  ],
  "workflowSteps": [
    {
      "ID": "cadena"
    }
  ],
  "dateDue": "2019-08-24T14:15:22Z",
  "nota": "cadena",
  "cliente": {
    "ID": "cadena"
  },
  "businessUnit": {
    "ID": "cadena"
  },
  "dominio": {
    "ID": "cadena"
  },
  "subdominio": {
    "ID": "cadena"
  },
  "costCenter": {
    "ID": "cadena"
  }
}{
  "proyecto": {
    "uid": "cadena"
  },
  "name": "cadena",
  "importSettings": {
    "uid": "cadena"
  },
  "useDynamicTitle": true,
  "dynamicTitle": "string"
}

Respuesta

UID del proyecto (p. ej., BmtNyVlz1skQd2aMVEipp9)

Creación de trabajo

Con el UID del proyecto de la última llamada, se pueden agregar nuevos trabajos directamente al proyecto recién creado utilizando Crear trabajo.

La expresión {projectUid} sirve como marcador de posición en la URL de solicitud donde se inserta el UID del proyecto obtenido. Con la llamada Crear API trabajo, los encabezados de la solicitud deben cambiarse en concordancia con los requeridos por phrase (en otras llamadas, Postman agrega automáticamente encabezados apropiados a la solicitud).

Todos los parámetros para importar deben insertarse en un encabezado Memsource personalizado.

El encabezado de disposición del contenido debe incluir el nombre del archivo en un formato predefinido a fin de procesar correctamente la solicitud de importar.

Para importar un archivo fuente, vaya al cuerpo, seleccione binario y aparezca la opción Seleccionar archivo.

Método

POST
Solicitar URL

https://cloud.memsource.com/web/api2/v1/projects/KmtNyVlz1skQd2aMVEipp7/jobs
(Cabecera) Disposición del contenido

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

{"targetLangs":["de","fr"]}
(Cabecera) Tipo de contenido

application/octet-stream
Respuesta

UID de trabajo (p. ej., dOYgeXzAdAbj4xFjuEVZP2)

UID AsyncRequest

Use Solicitud asíncrona con el UID AsyncRequest de la convocatoria Crear trabajo para comprobar que el trabajo se ha creado correctamente y que está funcional.

La UID de trabajo devuelta es única en cada paso del flujo de trabajo del proyecto. Por lo tanto, si el trabajo se crea en un proyecto con flujo de trabajo, la respuesta devuelve un UID de trabajo único para cada paso del flujo de trabajo.

Se pueden configurar configuraciones reutilizables para importar con la llamada Crear configuración importar. En la respuesta se recibe un UID de configuración Importar que se puede utilizar para crear la llamada de trabajo.

Para asignar proveedores al trabajo (a menos que se asignen directamente en la convocatoria Crear trabajo) use la convocatoria Editar trabajo.

El ID del proveedor que se inserta en la llamada se puede obtener de dos formas:

Para recuperar el ID de la aplicación phrase, sigue estos pasos:
1. Desde la página Configuración , baja hasta la sección Administración y haz clic en Usuarios o haz clic en Usuarios en la barra lateral.
  
  Se abre la página Usuarios.
2. Haz clic en el apellido del usuario y copia la última parte de la URL del navegador.
3. Use esta parte como el ID de ese usuario.
Utiliza la llamada a la API Listar usuarios.

Esta llamada API no requiere ningún parámetro específico y devolverá una lista de todos los usuarios de la cuenta. La respuesta contiene tanto nombres de usuario como ID.

Se puede añadir un parámetro opcional, userName, a la consulta que le permite listar solo usuarios con nombres de usuario específicos.

Notificar a los usuarios asignados

El trabajo UID puede utilizarse como parámetro opcional en la llamada Notificar a usuarios asignados junto con el parámetro de plantilla de correo electrónico que representa el ID de la plantilla de correo electrónico que se utilizará. Esto se puede obtener utilizando listas plantillas correo electrónico llamada.

Solicitar URL

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

Empty (estado 204: Sin contenido)

Aquí es donde el traductor comenzaría el trabajo en su perfil tal y como si se estuviera utilizando la interfaz de usuario de phrase. Una vez terminado el trabajo, el PM encargado recibe una notificación y se inicia la Siguiente parte del escenario. Se puede interceptar una rellamada mediante webhooks para iniciar automáticamente la Siguiente parte del escenario, pero esto no se abordará en este ejemplo.

Paso 3: Descargar archivo traducido (completar), cambiar proyecto a Terminado

Descargar archivo traducido

Esta hipótesis se basa en el supuesto de que un traductor termina su tarea (marca el trabajo como Terminado), pero el archivo terminado se puede descargar en cualquier momento, no hace falta que el trabajo tenga el estado Terminado.

Para descargar un archivo traducido se necesitan dos llamadas API: Descargar archivo meta (asincrónico) y Descargar archivo meta basado en llamadas de solicitud asíncronas.

El primer paso es llamar a Descargar archivo meta (asincronizado) con los parámetros projectUid y jobUid. Si va a descargar el archivo terminado de un proyecto con varios pasos del flujo de trabajo, asegúrese de usar el trabajo del paso del flujo de trabajo específico desde el que le gustaría descargar el archivo terminado, p. ej. el paso del flujo de trabajo de revisión.

Para recuperar el jobUID de un paso del flujo de trabajo específico de la aplicación phrase, sigue estos pasos:
1. Abrir el proyecto.
2. En la tabla Trabajos, cambie al paso del flujo de trabajo desde el que desea descargar el archivo terminado.
3. Copia la parte única de la URL después del trabajo desde el navegador.
Usa la lista trabajos API llamada.

Este extremo devuelve una lista de trabajos dentro del proyecto especificado. Usa la llamada con el parámetro de consulta workflowLevel. Este parámetro es un parámetro de base distinta de cero que indica el paso del flujo de trabajo al que pertenecen los trabajos devueltos. Si no se especifica, su valor se establece por defecto en 1 (= primer paso del flujo de trabajo). Por ejemplo, si necesita obtener los trabajos del paso de revisión, especifique el número de ese paso en el parámetro de consulta, es decir, 2.

La llamada Descargar archivo meta (asincrónico) inicia una solicitud asíncrona para generar y descargar el archivo meta que contiene traducciones. No proporciona directamente el archivo meta dentro de la respuesta, sino un asyncRequestId necesario para la siguiente llamada.

Método

PONER
Solicitar URL

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

AsyncRequest ID

Use Get asíncronous request with the asyncRequestID de la respuesta para comprobar que la solicitud se ha completado. Una vez que se complete la solicitud asíncrona, puede descargar el archivo meta utilizando el archivo meta Descargar llamada de solicitud asíncrona. El asyncRequestId se puede utilizar una sola vez. Una vez que se inicia la descarga, el asyncRequestId no es válido para usarlo más.

Método

OBTENER
Solicitar URL

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

Respuesta binaria con el propio archivo completado

Cambiar proyecto a Terminado

Para finalizar el proyecto una vez Completado el trabajo en el proyecto, use la llamada Editar estado proyecto con los parámetros obligatorios projectUid y estado para cambiar el estado de todo el proyecto a Terminado. Este cambio es manual, pero si se utiliza automatización del estado, el estado cambiará automáticamente. También es posible esperar un webhook e iniciar otras acciones basadas en la rellamada recibida.

Método

POST
Solicitar URL

https://cloud.memsource.com/web/api2/v1/projects/KmtNyVlz1skQd2aMVEipp7/setStatus
Organismo de solicitud
```
{ "estado": "TERMINADO"}
```
Respuesta

Empty (estado 204: Sin contenido)