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

Webhooks (TMS)

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

Доступно для

  • планов: Team, Professional, Business- и Enterprise

Свяжитесь с отделом продаж по вопросам лицензирования.

Вебхуки — это произвольные URL-адреса, которые обрабатывают запросы HTTP POST, позволяющие уведомление сторонние системы об указанных событиях.

Phrase отслеживает, если был успешно получен ответный вызов вебхука. Если прием вебхуков не удался 3000 раз, его отключают с помощью уведомления администраторов учетной записи и отмечают этот сбой на конкретном вебхуке на странице вебхуков. Механизм повторных попыток включает не более 10 повторов, при этом интервал между повторами рассчитывается в пределах не более 30 минут.

Вебхуки можно отключить/включить, протестировать или удалить со страницы вебхуков, наведя курсор на отдельные вебхуки и нажав ellipses.png, чтобы получить доступ к меню. Функция «История» содержит обзор обращений за предыдущие 14 дней. Также можно использовать неудачные вебхуки.

Важно

Соединения вебхуков из белого списка по IP-адресам устарели и были заменены токенами безопасности вебхуков.

Вебхуки можно выбрать для следующих событий:

  • Job status changed

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

  • Job assigned

  • Срок выполнения задания изменен

  • Оригинал задания обновлен

  • Задание переведено d (относится к действию по переводу заданий)

  • Продолжающееся задание обновлено

  • Проект создан

  • Статус проекта изменен

  • Срок выполнения проекта изменен

  • Шаблон проекта создан

  • Шаблон проекта изменен

  • Шаблон проекта удален

  • Shared project assigned

  • Метаданные проекта обновлены

  • Предварительный перевод завершен

  • Анализ создан

  • Задание удалено

  • Проект удален

  • Задание экспортировано

  • Задание не экспортировано

  • Импорт Y Language AI завершен

  • Перевод Language AI завершен

Настроить вебхуки

Для настройки вебхуков выполните следующие действия:

  1. Со страницы Setup_gear.png настроек прокрутите вниз раздел «Интеграции» и нажмите «Вебхуки».

    Открывается страница Webhooks.

  2. Нажмите Добавить вебхук.

    Открывается страница создания.

  3. Укажите URL-адрес.

  4. При необходимости предоставьте токен безопасности.

    Укажите значение, которое должно быть включено либо в заголовок токена x- Memsource, либо в заголовок «Авторизации» и позволит пользователю выбрать предпочтительный метод аутентификации отправителя вебхука.

  5. Выбрать события.

  6. Нажмите на схему Предварительного просмотра, чтобы просмотреть реакцию вебхука при запуске.

  7. Нажмите Создать вебхук.

    Вебхук добавлен в список на странице Вебхуки.

Примеры использования вебхуков

Веб-сайт под названием RequestBin предоставит URL-адрес для использования при создании вебхука.

При След. изменении статус задание или создании задание в учетная запись записи URL-адрес получает соответствующий ответ от системы. Фактическое использование может быть более сложным, и получение ответа следует расценивать как сигнал для выполнения подключенным приложением определенных действий.

События

Примеры изменить статус задание, назначения задание, создания задание и при изменении срока выполнения задание.

Статус задания изменился

{
"jobParts": [
  {
    "id": 9,
    "uid": "ipmdz5p0sagqcOYaijTZU2",
    "internalId": "4",
    "task": "SEfSaenvqFgctE1I0_dc1",
    "fileName": "en.txt",
    "targetLang": "af",
    «Уровень рабочего процесса»: 1,
    "status": "NEW",
    "wordsCount": 2,
    "beginIndex": 0,
    "endIndex": 1,
    «isParentJobSplit»: false,
    «dateDue»: null,
    "dateCreated": "2016-11-02T17:06:54Z",
    "проект": {
      "id": 2,
      «uid»: "4RvyVbwX00KerkomA7kpT9",
      «последний уровень рабочего процесса»: 1
    },
    "assignedTo": [
      {
        "Исполнитель": {
          "id": 1,
          "name": "Abc",
          "vendorToken": "4-ifos0-CAqPo"
        }
      },
      {
        "лингвист": {
          "id": 3,
          "firstName": "Администратор",
          "lastName": "Администратор",
          "userName": "admin",
          "электронная почта": "admin@example.com",
          «Роль»: "АДМИНИСТРАТОР",
          «Часовой пояс»: "Европа/Лондон",
          "активный": правда,
          «удален»: false,
          «терминолог»: ложный,
          "dateCreated": "2016-10-11T07:43:22Z"
        }
      }
    ]
  }
],
«Событие»: "JOB_STATUS_CHANGED"
}

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

{
"jobParts": [
  {
    "id": 9,
    "uid": "ipmdz5p0sagqcOYaijTZU2",
    "internalId": "4",
    "task": "SEfSaenvqFgctE1I0_dc1",
    "fileName": "en.txt",
    "targetLang": "af",
    «Уровень рабочего процесса»: 1,
    "status": "NEW",
    "wordsCount": 2,
    "beginIndex": 0,
    "endIndex": 1,
    «isParentJobSplit»: false,
    «dateDue»: null,
    "dateCreated": "2016-11-02T17:06:54Z",
    "проект": {
      "id": 2
      «uid»: "4RvyVbwX00KerkomA7kpT9",
      «последний уровень рабочего процесса»: 1
    },
    "assignedTo": [
      {
        "Исполнитель": {
          "id": 1,
          "name": "Abc",
          "vendorToken": "4-ifos0-CAqPo"
        }
      },
      {
        "лингвист": {
          "id": 3,
          "firstName": "Администратор",
          "lastName": "Администратор",
          "userName": "admin",
          "электронная почта": "admin@example.com",
          «Роль»: "АДМИНИСТРАТОР",
          «Часовой пояс»: "Европа/Лондон",
          "активный": правда,
          «удален»: false,
          «терминолог»: ложный,
          "dateCreated": "2016-10-11T07:43:22Z"
        }
      }
    ]
  }
],
«Событие»: «ЗАДАНИЕ_НАЗНАЧЕНО»
}

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

{
 "jobParts": [
   {
     "id": 9,
     "uid": "ipmdz5p0sagqcOYaijTZU2",
     "internalId": "4",
     "task": "SEfSaenvqFgctE1I0_dc1",
     "fileName": "en.txt",
     "targetLang": "af",
     «Уровень рабочего процесса»: 1,
     "status": "NEW",
     "wordsCount": 2,
     "beginIndex": 0,
     "endIndex": 1,
     «isParentJobSplit»: false,
     «dateDue»: null,
     "dateCreated": "2016-11-02T17:06:54Z",
     "проект": {
       "id": 2,
       «uid»: "4RvyVbwX00KerkomA7kpT9",
       «последний уровень рабочего процесса»: 1
     },
     "assignedTo": [
       {
         "Исполнитель": {
           "id": 1,
           "name": "Abc",
           "vendorToken": "4-ifos0-CAqPo"
         }
       },
       {
         "лингвист": {
           "id": 3,
           "firstName": "Администратор",
           "lastName": "Администратор",
           "userName": "admin",
           "электронная почта": "admin@example.com",
           «Роль»: "АДМИНИСТРАТОР",
           «Часовой пояс»: "Европа/Лондон",
           "активный": правда,
           «удален»: false,
           «терминолог»: ложный,
           "dateCreated": "2016-10-11T07:43:22Z"
         }
       }
     ]
   }
 ],
 «Событие»: «ЗАДАНИЕ_СОЗДАНО»
}

Срок выполнения задания изменен

{
  "jobParts": [
    {
      "id": 127865777,
      «uid»: "ElTXvXnNIHEN2xgL5sU2L2",
      "internalId": "1",
      "task": "LvkAHilgobApeoVm_dc4",
      "fileName": "EU White Paper Edited.doc",
      "targetLang": "de",
      «Уровень рабочего процесса»: 1,
      "status": "NEW",
      "wordsCount": 204,
      "beginIndex": 0,
      "endIndex": 16,
      «isParentJobSplit»: false,
      "dateDue": "2018-09-11T22:00:00Z",
      "dateCreated": "2018-09-10T06:25:41Z",
      "проект": {
        "id": 12277756,
        «uid»: "4RvyVbwX00KerkomA7kpT9
        «последний уровень рабочего процесса»: 1
      },
      "assignedTo": []
    }
  ],
  «Событие»: "JOB_DUE_DATE_CHANGED"
}

Таблица статуса

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

Rest интерфейс приложений API

Вебхук

UI

НОВЫЙ

НОВЫЙ

НОВЫЙ

ПРИНЯТО

НАЗНАЧЕНО

ПРИНЯТО (по поставщику)

ОТКЛОНЕНО

DECLINED_BY_LINGUIST

ОТКЛОНЕНО (по поставщикам)

ОТКЛОНЕНО

НЕ ПРИНЯТО_ПО_ЛИНГВИСТУ

НЕ ПРИНЯТО (поставщиком)

ДОСТАВЛЕНО

ЗАВЕРШЕНО

ДОСТАВЛЕНО

ОТПРАВЛЕНО

ОТПРАВЛЕНО

ОТПРАВЛЕНО (по поставщику)

ЗАВЕРШЕНО

COMPLETED_BY_LINGUIST

ЗАВЕРШЕНО (по поставщикам)

ОТМЕНЕНО

ОТМЕНЕНО

ОТМЕНЕНО

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

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.