Использование интерфейс приложений API (TMS)

Контент автоматически переведен с английского языка с помощью Phrase Language AI.

Это простой сценарий интерфейс приложений API с примерами вызовов интерфейс приложений API и инструкциями о том, как объединить их для выполнения простого действия с помощью только интерфейс приложений API. Параметры, которые можно задать через интерфейс приложений API, обширны. Обратитесь к соответствующим разделам документации по REST интерфейс приложений API, чтобы узнать больше обо всех доступных параметрах.

Для создания сценария использовалась платформа интерфейс приложений API Postman.

В этих примерах стандартный URL-адрес запроса начинается с https://cloud.memsource.com. Если интерфейс приложений API используются организация в центр хранения и обработки данных в США, URL-адрес запроса должен начинаться с https://us.cloud.memsource.com.

Сценарий

аутентификация

Пользователь проходит аутентификация (эквивалент входа в систему через интерфейс приложений API).
Создать

Создание простого проект, загрузка заданий и назначение лингвист с уведомление по электронная почта.
Перевод

Работа по перевод, выполняемая вне сценария интерфейс приложений API (в любом из редакторов).
Функция интерфейс приложений API

Как только работа завершена (отмечена как Завершить лингвист), статус проект устанавливается на Завершить, а готовый документ загружается из проект.

Методология

Для каждого отдельного вызова REST интерфейс приложений API указан соответствующий метод. Использование неверного метода (например, GET вместо POST в вызове создание проект) приводит к неудачному вызову интерфейс приложений API.

Этап 1: аутентификация

Существует два метода аутентификации:

Вызов интерфейс приложений API аутентификации:

Генерирует токен аутентификации, действительный в течение 24 часов. Токен необходимо вставлять во все последующие интерфейс приложений API. Токен проверяет пользователей и позволяет им выполнять любые другие функции в рамках профиль.
OAuth 2.0

Позволяет выполнить проверку приложения. Проверенное приложение находится в постоянном взаимодействии и не требует дальнейшей аутентификации.

Для этого сценария используется вызов интерфейс приложений API аутентификации. Сгенерированный токен требуется для всех последующих вызовов интерфейс приложений API и не указан в примерах параметров.

Использовать интерфейс приложений API Login для аутентификации с обязательными параметрами. В этом случае требуются username и password.

Метод

POST
URL-адрес запроса

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

Тело запроса:

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

Ответ

Токен аутентификации.

Участники нескольких организаций TMS имеют одинаковые имя пользователя и пароль для нескольких учетных записей. В этом случае userUid должен быть добавлен в тело запроса, чтобы указать, в какую организация пользователь хочет войти. Если не указано иное, пользователь входит в учетная запись по умолчанию, связанную с заданным именем пользователя и паролем.

Этап 2: Создать проект, импортировать и назначение

Создать проект

Использовать интерфейс приложений API Projects, чтобы Создать проект с обязательными параметрами name, sourceLang и targetLangs.

Метод

POST
URL-адрес запроса

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

Тело запроса

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

Ответ

Идентификатор проект (например, KmtNyVlz1skQd2aMVEipp7)

Можно Создать шаблон проект, используя интерфейс приложений API Создать проект шаблон с Идентификатор проект из последнего вызова.

Метод

POST
URL-адрес запроса

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

Тело запроса

{
  "project": {
    "uid": "строка"
  },
  "name": "строка",
  "importSettings": {
    "uid": "строка"
  },
  "useDynamicTitle": true,
  "dynamicTitle": "string"
}

Ответ

Идентификатор шаблон проекта (например, AmtNyVlz1skQd2aMVEipp8)

Самый эффективный способ создавать проект — использовать шаблон проект. Использовать Создать проект из шаблон с Идентификатор шаблон проекта из последнего вызова, чтобы Создать новый проект на основе настройки шаблон проект.

Выражение {templateUid} служит в качестве заполнитель в URL-адресе запроса, куда вставляется полученный Идентификатор шаблон проекта.

Метод

POST
URL-адрес запроса

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

Тело запроса

{
  "name": "строка",
  "sourceLang": "string",
  "targetLangs": [
    "строка"
  ],
  "workflowSteps": [
    {
      "Идентификатор": "строка"
    }
  ],
  "dateDue": "2019-08-24T14:15:22Z",
  "note": "строка",
  "client": {
    "Идентификатор": "строка"
  },
  "businessUnit": {
    "Идентификатор": "строка"
  },
  "domain": {
    "Идентификатор": "строка"
  },
  "subDomain": {
    "Идентификатор": "строка"
  },
  "costCenter": {
    "Идентификатор": "строка"
  }
}{
  "project": {
    "uid": "строка"
  },
  "name": "строка",
  "importSettings": {
    "uid": "строка"
  },
  "useDynamicTitle": true,
  "dynamicTitle": "string"
}

Ответ

UID проекта (например, BmtNyVlz1skQd2aMVEipp9)

Создать задание

С UID проекта из последнего вызова новые задания можно добавлять непосредственно в только что созданный проект, используя Create Job.

Выражение {projectUid} служит в качестве заполнителя в URL запроса, куда вставляется полученный UID проекта. При вызове интерфейс приложений API Создать задание Headers запроса должны быть изменены, чтобы обеспечить совпадение с теми, которые требуются Phrase (в других вызовах Postman автоматически добавляет соответствующие заголовки к запросу).

Все параметры импорта необходимо вставить в Пользовательский заголовок Memsource.

Заголовок Content-Disposition должен включать имя файла в заранее определенном формат для того, чтобы правильно обработать заказ на импорт.

Чтобы импортировать оригинал файл, перейдите в тело, выбрать binary, и появится опция Select File.

Метод

POST
URL-адрес запроса

https://cloud.memsource.com/web/api2/v1/projects/KmtNyVlz1skQd2aMVEipp7/jobs
(Заголовок) Content-Disposition

filename*=UTF-8''file.txt
(Заголовок) Memsource

{"targetLangs":["de","fr"]}
(Заголовок) Content-Type

application/octet-stream
Ответ

Job UID (e.g. dOYgeXzAdAbj4xFjuEVZP2)

UID AsyncRequest

Используйте Get asynchronous request с UID AsyncRequest из вызова Создать задание, чтобы проверить, что задание было успешно создано и оно функционирует.

Возвращенный UID задания является уникальным для каждого этапа рабочего процесса проекта. Поэтому, если задание создается в проекте с рабочим процессом, ответ возвращает уникальный UID задания для каждого этапа рабочего процесса.

Повторно используемые настройки импорта можно сконфигурировать с помощью вызова Create import settings. UID настроек импорта, который можно использовать в вызове создать задание, получается в ответе.

Чтобы назначить исполнителей на задание (если они не были назначены непосредственно в вызове Создать задание), используйте вызов Edit job.

Идентификатор поставщика, который вставляется в вызов, можно получить двумя способами:

Чтобы получить Идентификатор из приложения Phrase, выполните следующие действия:
1. На странице настройки прокрутите вниз до раздела Администрирование и нажмите Пользователи или нажмите Пользователи на боковой панели.
  
  Откроется страница Пользователи.
2. Нажмите на фамилию<1> пользователя и скопируйте последнюю часть URL из браузера.
3. Использовать эту часть в качестве Идентификатор для этого пользователь.
Использовать Список пользователей вызов интерфейс приложений API.

Этот вызов интерфейс приложений API не требует никаких специальных параметров, и он вернет список всех пользователь в учетная запись. Ответ содержит как имена пользователей, так и Идентификатор.

Дополнительный параметр, userName, можно добавить в запрос, что позволит вам получить список только пользователей с определенными именами пользователей.

Уведомить назначенных пользователей

Идентификатор задания (UID) затем можно использовать в качестве дополнительного параметра в вызове Уведомить назначенных пользователей вместе с параметром emailTemplate, представляющим Идентификатор шаблона электронная почта, который необходимо использовать. Его можно получить с помощью вызова Список шаблонов электронная почта.

URL-адрес запроса

https://cloud.memsource.com/web/api2/v1/projects/KmtNyVlz1skQd2aMVEipp7/jobs/notifyAssigned
Ответ

Пустой (статус 204: Нет контент)

Именно здесь переводчик начнет работу в своем профиль, как если бы использовался интерфейс приложений API Phrase. После того как задание завершено, ответственный менеджер проекта (PM) получает уведомление, и начинается След. часть сценария. Обратный вызов можно перехватить с помощью webhooks для автоматического запуска След. части сценария, но в этом примере это рассматриваться не будет.

Этап 3: Скачать переведенный (завершенный) файл, установить статус проект на «Завершено»

Скачать переведенный файл

Этот сценарий работает с допущением, что переводчик завершает свою работу (отмечает задание как Завершено), но завершенный файл можно Скачать в любое время, задание не обязательно должно иметь статус Завершено.

Чтобы Скачать перевод, необходимы два вызова интерфейс приложений API: Скачать перевод (асинхронно) и Скачать перевод на основе асинхронного запроса.

Первый этап — вызвать Скачать перевод (асинхронно) с параметрами projectUid и jobUid. Если вы скачиваете готовый файл из проект с несколькими этап рабочего процесса, убедитесь, что вы используете jobUid с конкретного этап рабочего процесса, с которого вы хотите Скачать готовый файл, например, этап рабочего процесса редактирования.

Чтобы получить jobUID для конкретного этап рабочего процесса из приложения Phrase, выполните следующие этап:
1. Откройте проект.
2. В таблице Задания переключитесь на этап рабочего процесса, с которого вы хотите Скачать готовый файл.
3. Скопируйте уникальную часть URL после /job из браузера.
Использовать Список задания интерфейс приложений API вызов.

Эта конечная точка возвращает список задания в указанном проект. Использовать вызов с параметром запрос workflowLevel. Этот параметр не является основанным на нуле и указывает на этап рабочего процесса, к которому относятся возвращенные задания. Если он не указан, по умолчанию его значение устанавливается на 1 (= первый этап рабочего процесса). Например, если вам нужно получить задания с этапа редактирования, укажите номер этого этап в параметре запрос, т.е. 2.

Вызов Скачать перевод (асинхронно) инициирует асинхронный запрос на создание и скачивание файла, содержащего перевод. Он не предоставляет перевод напрямую в ответе, а возвращает asyncRequestId, необходимый для следующего вызова.

Метод

PUT
URL-адрес запроса

https://cloud.memsource.com/web/api2/v2/projects/KmtNyVlz1skQd2aMVEipp7/jobs/dOYgeXzAdAbj4xFjuEVZP2/targetFile
Ответ

Идентификатор AsyncRequest

Использовать Получить асинхронный запрос с asyncRequestID из ответа, чтобы проверить, завершен ли запрос. Как только асинхронный запрос будет завершен, вы можете Скачать перевод, используя вызов Скачать перевод на основе асинхронного запроса. asyncRequestId можно использовать только один раз. Как только скачивание инициировано, asyncRequestId становится недействительным для дальнейшего использования.

Метод

GET
URL-адрес запроса

https://cloud.memsource.com/web/api2/v2/projects/KmtNyVlz1skQd2aMVEipp7/jobs/dOYgeXzAdAbj4xFjuEVZP2/downloadTargetFile/1291716982
Ответ

Бинарный ответ с самим файлом, для которого выполнено действие Завершить

Установить проект в статус Завершить

Чтобы завершить проект после того, как задание в проекте будет выполнено, используйте вызов редактировать статус проект с обязательными параметрами projectUid и статус, чтобы изменить статус всего проект на Завершить. Это изменение выполняется вручную, но если используется автоматизация статус проект, статус будет изменен автоматически. Также можно дождаться вебхук и инициировать другие действия на основе полученного обратного вызова.

Метод

POST
URL-адрес запроса

https://cloud.memsource.com/web/api2/v1/projects/KmtNyVlz1skQd2aMVEipp7/setStatus
Тело запроса
```
{ "статус": "COMPLETED"}
```
Ответ

Пустой (статус 204: Нет контент)