Управляем командой через API MyTeam

API MyTeam позволяет управлять «Моей командой» в Smartcat: находить, добавлять и удалять участников, а также назначать их на проекты перевода.

Добавляем нового участника команды

Чтобы добавить нового участника в команду Smartcat через API, используйте метод POST account/myteam.

Пример: account/myteam

Request URL: 
https://smartcat.ai/api/integration/v1/account/myteam

Headers:
Content-Type: application/json

Body:
{
"firstName": "John",
"lastName": "Doe",
"externalID": "1150",
"email": "johndoe@mailforspam.com",
"services": [{
     "serviceType": "translation",
     "specializations": ["education", "marketing"],
     "sourceLanguage": "ru",
     "targetLanguage": "fr",
     "unitsType": "word",
     "pricePerUnit": "0.07",
     "currency": "USD"
     }]
}

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

В модель услуги входит языковая пара или отдельный язык — в зависимости от вида услуги, — ставка и валюта. Smartcat автоматически устанавливает соответствующие единицы измерения в зависимости от типа услуг.

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

Пример: directory

Request URL: 
https://smartcat.ai/api/integration/v1/directory?type=language

Headers:
Authorization: Basic dGVzdGFwaToxMjM0NTY=

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

Есть некоторые ограничения:

  • Имя и фамилия не могут быть длиннее 99 символов.
  • Нельзя добавлять разные ставки для разных диалектов в рамках одной услуги. Например, нельзя установить одному человеку ставку $0,06 за перевод с английского на французский (Франция) и $0,08 за перевод с английского на французский (Канада).

Других ограничений нет.

Находим участников команды

Чтобы найти участников команды по фильтру, используйте метод POST account/searchmyteam.

Пример: account/searchMyTeam

Request URL: 
https://smartcat.ai/api/integration/v1/account/searchmyteam

Headers:
Authorization: Basic ZG0wMTpRd2VydHkxMjM=
Content-Type: application/json

Body to get the first 500 profiles:
{
"skip": 0,
"limit": 500
}

Body to get the profiles in order from 501 to 1000:
{
"skip": 500,
"limit": 500
}

Body with all parameters:
{
"skip": 0,
"limit": 500,
"serviceType": "translation",
"sourceLanguage": "en",
"targetLanguage": "af",
"onlyNativeSpeakers": false,
"allDialects": true,
"minRate": 0,
"maxRate": 7,
"rateRangeCurrency": "USD",
"specializations": [
"IT"
],
"specializationKnowledgeLevel": [
"tested"
],
"searchString": "batman",
"daytime": false,
}

Вы можете фильтровать поиск по типам услуг, языковым парам, ставкам и специализациям. Также можно отбирать участников, у которых сейчас дневное время, тех, кто является носителем целевого языка, или тех, кто прошёл тестирование.

Если вы не укажете ни одного фильтра, вы получите весь список участников команды. Это может быть удобно, если вы хотите синхронизировать список участников со своими другими TMS/ERP-системами.

За один раз можно получить не больше 500 участников (значение параметра limit). Если у вас больше участников в команде, используйте параметр skip. Например, если в вашей команде 600 человек, Вы можете получить первые 500 профилей в первом запросе, а остальные — во втором. Для этого во втором запросе установите параметр skip равным 500, и вы получите профили участников с 501-го по 600-й.

Удаляем участника команды

Чтобы удалить участника команды, используйте метод DELETE account/myteam/{userid}, где userId — идентификатор пользователя в Smartcat.

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

Пример: account/myteam/{userId}

Request URL: 
https://smartcat.ai/api/integration/v1/account/myteam/6a097370-75a3-4bcc-b37b-2c3fd339b2dd

Headers:
Authorization: Basic dGVzdGFwaToxMjM0NTY=

Назначаем команду на перевод документа

Чтобы назначить подходящих участников команды на перевод документа, используйте метод POST document/assignFromMyTeam.

В запросе передайте параметр documentIds, содержащий список идентификаторов документов с указанием номера целевого языка через нижнее подчёркивание, stageNumber — номер этапа для многоэтапных проектов, — и subjects — идентификаторы специализаций.

Пример: document/assignFromMyTeam

Request URL: 
https://smartcat.ai/api/integration/v1/document/assignFromMyTeam

Headers:
Authorization: Basic ZG0wMTpRd2VydHkxMjM=
Content-Type: application/json

Body:
{
  "documentIds": [
     "documentId_12"
  ],
  "stageNumber": 1,
  "specializations": [
     "tourismandtravel",
     "recreation"
  ]
}

В результате Smartcat разошлёт приглашения участникам команды с подходящим целевым языком и специализацией (если она указана в запросе). В примере выше, приглашение получат как участники со специализацией Туризм, так и участники со специализацией Отдых. Первый участник, подтвердивший приглашение, сможет сразу начать работать над переводом.

Понравилось?

1

Похожие статьи:

    Нет похожих статей