Интерфейс приложений API Phrase TMS

Using APIs (TMS)

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

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

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

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

Сценарий

  1. Аутентификация  

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

  2. Создание  

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

  3. Перевод 

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

  4. Функция API 

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

Методология

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

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

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

  1. Интерфейс приложений API аутентификации:

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

  2. oAuth 2.0:

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

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

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

  • Метод 

    POST

  • Запросить URL-адрес 

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

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

    { "имя пользователя":"имя пользователя", "пароль":"пароль"}
  • Ответ 

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

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

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

Создание проекта

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

  • Метод 

    POST

  • Запросить URL-адрес 

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

  • Запрос тела 

    { "name":"Мой проект", "sourceLang":"en", "targetLangs":[ "de","fr" ]}
  • Ответ 

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

Шаблон проекта можно создать с помощью интерфейса приложений API Создать шаблон проекта с UID проекта после последнего вызова.

  • Метод 

    POST

  • Запросить URL-адрес 

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

  • Запрос тела 

    {
      "проект": {
        "uid": "строка"
      },
      "имя": "строка",
      «Настройки импорта»: {
        "uid": "строка"
      },
      «useDynamicTitle»: правда,
      "dynamicTitle": "строка"
    }
  • Ответ 

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

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

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

  • Метод 

    POST

  • Запросить URL-адрес 

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

  • Запрос тела 

    {
      "имя": "строка",
      "sourceLang": "строка",
      «targetLangs»: [
        «строка»
      ],
      «этапы рабочего процесса»: [
        {
          "Идентификатор": "строка"
        }
      ],
      «DateDue»: "2019-08-24T14:15:22Z",
      "примечание": "строка",
      "клиент": {
        "Идентификатор": "строка"
      },
      «бизнес-подразделение»: {
        "Идентификатор": "строка"
      },
      «отрасль»: {
        "Идентификатор": "строка"
      },
      "Специализация": {
        "Идентификатор": "строка"
      },
      «costCenter»: {
        "Идентификатор": "строка"
      }
    }{
      "проект": {
        "uid": "строка"
      },
      "имя": "строка",
      «Настройки импорта»: {
        "uid": "строка"
      },
      «useDynamicTitle»: правда,
      "dynamicTitle": "строка"
    }
  • Ответ 

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

Задание создано

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

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

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

Заголовок «Распоряжение контентом» должен включать имя файла в заданном формате для заказа корректной обработки импортируемого запроса.

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

  • Метод 

    POST

  • Запросить URL-адрес 

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

  • (Заголовок) Отображение контента 

    filename*=UTF-8''file.txt 

  • (Заголовок) Memsource 

    {"targetLangs":["de","fr"]} 

  • (Заголовок) Тип контента 

    приложение/октет-поток

  • Ответ 

    UID задания (например, dOYgeXzAdAbj4xFjuEVZP2)

    AsyncRequest UID

Используйте «Получить асинхронный запрос с асинхронным идентификатором запроса» из вызова «Создать задание», чтобы проверить успешность создания задания и его работоспособность.

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

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

Чтобы назначить поставщиков задания (если оно не назначено непосредственно в вызове Создать задание) используйте вызов Редактировать задание.

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

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

    1. На Setup_gear.pngстранице настроек прокрутите вниз раздел «Администрирование», нажмите «Пользователи» или нажмите «Пользователи» на боковой панели.

      Открывается страница Пользователей.

    2. Нажмите на фамилию пользователя и скопируйте последнюю часть URL-адреса из браузера.

    3. Используйте эту часть в качестве Идентификатора этого пользователя.

  • Используйте интерфейс приложений API списка пользователей. 

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

    К запросу можно добавить необязательный параметр — имя пользователя, позволяющий вносить в список только пользователей с конкретными именами пользователей.

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

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

  • Запросить URL-адрес 

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

  • Ответ 

    empty (Статус 204: Нет контента) 

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

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

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

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

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

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

  • Чтобы получить jobUID для определенного этапа рабочего процесса из приложения Phrase, выполните следующие действия: 

    1. Открыть проект.

    2. В таблице заданий переключитесь на этап рабочего процесса, с которого вы хотите скачать завершенный файл.

    3. Скопируйте уникальную часть URL-адреса после /задания из браузера.

  • Используйте вызов интерфейса приложений API List Jobs. 

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

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

  • Метод 

    ПОЛОЖИТЬ

  • Запросить URL-адрес 

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

  • Ответ 

    Идентификатор асинхронного запроса

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

  • Метод 

    Получить

  • Запросить 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 

  • Запрос тела 

    { "статус": «ЗАВЕРШЕНО»}
  • Ответ 

    empty (Статус 204: Нет контента)

Была ли эта статья полезной?

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.