Полный список методов интеграционного API платформы Plaia. Оригинальный Swagger-справочник с моделями запросов: app.plaia.ru/api/methods ↗.
Базовый URL: https://app.plaia.ru/api/integration/v1 · Аутентификация: API-ключи (accountId и токен).
| Метод | Путь | Описание |
|---|---|---|
GET |
/api/integration/v1/account |
Получить данные аккаунта |
GET |
/api/integration/v1/account/mtengines |
Получить список MT-сервисов, доступных аккаунту |
| Метод | Путь | Описание |
|---|---|---|
GET |
/api/integration/v1/callback |
Получить настройки уведомлений (вебхуков) аккаунта |
POST |
/api/integration/v1/callback |
Создать или обновить настройки уведомлений |
DELETE |
/api/integration/v1/callback |
Удалить настройки уведомлений |
GET |
/api/integration/v1/callback/lastErrors |
Получить последние ошибки доставки уведомлений |
| Метод | Путь | Описание |
|---|---|---|
POST |
/api/integration/v1/client/create |
Создать клиента с указанным именем и вернуть его ID (если клиент уже существует — вернуть существующий ID) |
PUT |
/api/integration/v1/client/{clientId}/set |
Применить нет-рейт (скидку по совпадениям) к указанному клиенту |
PUT |
/api/integration/v1/client/{clientId}/contact |
Задать контактные данные клиента |
PUT |
/api/integration/v2/client/{clientId} |
Обновить данные клиента |
GET |
/api/integration/v2/client/{clientId} |
Получить информацию о клиенте (v2) |
GET |
/api/integration/v1/client/{clientId} |
Получить информацию о клиенте |
| Метод | Путь | Описание |
|---|---|---|
GET |
/api/integration/v1/clientIndustry/{id} |
Получить запись справочника отраслей по ID |
PUT |
/api/integration/v1/clientIndustry/{id} |
Обновить название записи справочника |
DELETE |
/api/integration/v1/clientIndustry/{id} |
Удалить запись справочника |
GET |
/api/integration/v1/clientIndustry |
Получить все значения справочника отраслей |
POST |
/api/integration/v1/clientIndustry/{name} |
Добавить запись в справочник |
| Метод | Путь | Описание |
|---|---|---|
GET |
/api/integration/v1/directory |
Получить указанный справочник |
GET |
/api/integration/v1/directory/formats |
Получить форматы разбора файлов, поддерживаемые аккаунтом |
| Метод | Путь | Описание |
|---|---|---|
GET |
/api/integration/v1/document |
Получить данные документа |
DELETE |
/api/integration/v1/document |
Удалить один или несколько документов |
GET |
/api/integration/v1/document/translate/status |
Получить статус добавления перевода документа |
GET |
/api/integration/v1/document/translate/result |
Получить детальный отчёт по импорту перевода |
GET |
/api/integration/v1/document/statistics |
Получить статистику документа |
POST |
/api/integration/v1/document/assignFreelancers |
Разделить документ на равные блоки по словам и назначить блок фрилансерам |
POST |
/api/integration/v1/document/assignVendors |
Назначить вендора на этап workflow документа |
POST |
/api/integration/v1/document/setStageUnitCount |
Задать количество единиц для этапа workflow документа |
POST |
/api/integration/v1/document/assign |
Задать модель назначения лингвистов и распределения сегментов |
POST |
/api/integration/v1/document/unassign |
Снять назначение лингвиста |
POST |
/api/integration/v1/document/assignFromMyTeam |
Отправить приглашения лингвистам MyTeam: назначить первого принявшего на каждый нераспределённый сегмент |
POST |
/api/integration/v1/document/complete |
Перевести документ в статус Completed |
PUT |
/api/integration/v1/document/update |
Обновить документ |
PUT |
/api/integration/v1/document/rename |
Переименовать документ |
PUT |
/api/integration/v1/document/translate |
Импортировать перевод документа из файла перевода |
PUT |
/api/integration/v1/document/translateWithXliff |
Импортировать перевод документа из XLIFF-файла |
| Метод | Путь | Описание |
|---|---|---|
GET |
/api/integration/v1/document/export/{taskId} |
Скачать результат экспорта по ID задачи |
POST |
/api/integration/v1/document/export |
Запросить экспорт документов |
| Метод | Путь | Описание |
|---|---|---|
GET |
/api/integration/v1/fileDisassemblingAlgorithmPresets/{id} |
Получить пресет алгоритма разбора файлов |
PUT |
/api/integration/v1/fileDisassemblingAlgorithmPresets/{id} |
Обновить пресет разбора |
DELETE |
/api/integration/v1/fileDisassemblingAlgorithmPresets/{id} |
Удалить пресет |
GET |
/api/integration/v1/fileDisassemblingAlgorithmPresets |
Получить все пресеты аккаунта |
POST |
/api/integration/v1/fileDisassemblingAlgorithmPresets |
Создать пресет алгоритма разбора |
| Метод | Путь | Описание |
|---|---|---|
GET |
/api/integration/v1/glossaries |
Получить глоссарии текущего аккаунта |
POST |
/api/integration/v1/glossary/import |
Создать задачу импорта концептов в файл глоссария |
GET |
/api/integration/v1/glossary/importTaskState/{taskId} |
Получить статус задачи импорта концептов |
| Метод | Путь | Описание |
|---|---|---|
POST |
/api/integration/v1/invoice/job |
Создать платёж исполнителю (фрилансеру) |
POST |
/api/integration/v2/invoice/job |
Создать платёж (v2) |
POST |
/api/integration/v1/invoice/jobs |
Создать массив платежей исполнителям |
POST |
/api/integration/v2/invoice/jobs |
Создать массив платежей (v2) |
GET |
/api/integration/v1/invoice/job/list |
Получить список платежей исполнителям |
GET |
/api/integration/v2/invoice/job/listByExternalId |
Получить список платежей по внешнему ID |
GET |
/api/integration/v2/invoice/job/listByCreatedDate |
Получить список платежей по дате создания |
GET |
/api/integration/v2/invoice/list |
Получить список счетов за указанный период |
GET |
/api/integration/v2/client-agent-invoice/list |
Получить список агентских счетов |
| Метод | Путь | Описание |
|---|---|---|
GET |
/api/integration/v3/job/verifiedForProject |
Получить список задач (jobs) проекта |
| Метод | Путь | Описание |
|---|---|---|
DELETE |
/api/integration/v1/lsp/prices/{priceId} |
Удалить цену услуги LSP |
GET |
/api/integration/v2/lsp/prices |
Получить цены услуг LSP по ID |
POST |
/api/integration/v2/lsp/prices |
Создать новую цену услуги LSP |
GET |
/api/integration/v2/lsp/prices/batch |
Получить цены услуг LSP (батч) |
POST |
/api/integration/v2/lsp/prices/batch |
Создать цены услуг LSP (батч) |
PUT |
/api/integration/v2/lsp/prices/{priceId} |
Обновить цену услуги LSP |
| Метод | Путь | Описание |
|---|---|---|
DELETE |
/api/integration/v1/lsp/services/{serviceId} |
Удалить услугу LSP |
GET |
/api/integration/v2/lsp/services |
Получить услуги LSP по ID |
POST |
/api/integration/v2/lsp/services |
Создать новую услугу LSP |
GET |
/api/integration/v2/lsp/services/batch |
Получить услуги LSP (батч) |
POST |
/api/integration/v2/lsp/services/batch |
Создать услуги LSP (батч) |
PUT |
/api/integration/v2/lsp/services/{serviceId} |
Обновить услугу LSP |
| Метод | Путь | Описание |
|---|---|---|
GET |
/api/integration/v1/account/myTeam/{userId} |
Получить профиль участника MyTeam по ID |
DELETE |
/api/integration/v1/account/myTeam/{userId} |
Удалить пользователя из MyTeam |
GET |
/api/integration/v1/account/myTeam |
Получить профиль участника MyTeam по внешнему ID |
POST |
/api/integration/v1/account/myTeam |
Добавить штатного переводчика в MyTeam как лингвиста |
POST |
/api/integration/v1/account/searchMyTeam |
Искать лингвистов в MyTeam |
POST |
/api/integration/v1/account/myTeam/{userId}/services/replace |
Заменить все услуги в профиле MyTeam |
PUT |
/api/integration/v1/account/myTeam/{userId}/phone |
Добавить телефон участника MyTeam |
PUT |
/api/integration/v1/account/myTeam/{userId}/comment |
Добавить комментарий к профилю участника MyTeam |
| Метод | Путь | Описание |
|---|---|---|
GET |
/api/integration/v1/placeholders |
Получить все форматы плейсхолдеров аккаунта |
PUT |
/api/integration/v1/placeholders |
Сохранить набор форматов плейсхолдеров аккаунта |
GET |
/api/integration/v1/placeholders/validate |
Валидировать указанный формат плейсхолдеров |
| Метод | Путь | Описание |
|---|---|---|
GET |
/api/integration/v1/project/{projectId} |
Получить модель проекта |
PUT |
/api/integration/v1/project/{projectId} |
Обновить проект по ID |
DELETE |
/api/integration/v1/project/{projectId} |
Удалить проект |
GET |
/api/integration/v1/project/list |
(Устарел: заменён на /api/integration/v2/project/list) Получить список проектов аккаунта |
GET |
/api/integration/v2/project/list |
Получить список проектов аккаунта |
GET |
/api/integration/v1/project/{projectId}/statistics |
(Устарел: заменён на v2) Получить статистику проекта |
GET |
/api/integration/v2/project/{projectId}/statistics |
Получить статистику проекта |
GET |
/api/integration/v1/project/{projectId}/completedWorkStatistics |
Получить статистику выполненных частей проекта |
GET |
/api/integration/v1/project/{projectId}/translationmemories |
Получить список TM, подключённых к проекту |
POST |
/api/integration/v1/project/{projectId}/translationmemories |
Пересоздать набор TM проекта (единый для всех целевых языков) |
POST |
/api/integration/v1/project/{projectId}/translationmemories/bylanguages |
Пересоздать набор TM проекта (отдельный набор для каждого целевого языка) |
GET |
/api/integration/v1/project/{projectId}/glossaries |
Получить список глоссариев, подключённых к проекту |
PUT |
/api/integration/v1/project/{projectId}/glossaries |
Задать набор глоссариев, подключённых к проекту |
GET |
/api/integration/v1/project/{projectId}/mt |
Получить конфигурацию MT проекта |
POST |
/api/integration/v1/project/{projectId}/mt |
Задать конфигурацию MT в проекте |
GET |
/api/integration/v1/project/{projectId}/mt/available |
Получить все MT-движки и профили, доступные в проекте |
POST |
/api/integration/v1/project/cancel |
Отменить проект |
POST |
/api/integration/v1/project/restore |
Восстановить проект |
POST |
/api/integration/v1/project/complete |
Завершить workflow по всем документам проекта (статус → Completed) |
POST |
/api/integration/v1/project/create |
Создать проект |
POST |
/api/integration/v1/project/document |
Добавить документ в проект |
POST |
/api/integration/v1/project/language |
Добавить новый целевой язык в проект |
POST |
/api/integration/v1/project/{projectId}/statistics/build |
Запустить пересчёт статистики проекта |
POST |
/api/integration/v1/project/{projectId}/managers |
Добавить менеджеров в проект |
DELETE |
/api/integration/v1/project/{projectId}/managers |
Удалить менеджеров из проекта |
POST |
/api/integration/v1/project/{projectId}/assign |
Автоматически назначить новые документы/сегменты текущим лингвистам |
| Метод | Путь | Описание |
|---|---|---|
POST |
/api/integration/v1/backup/project/{projectId} |
Запустить задачу создания резервной копии проекта |
GET |
/api/integration/v1/backup/project/tasks/create |
Получить ожидающие задачи создания бэкапов |
GET |
/api/integration/v1/backup/project/tasks/create/{taskId}/download |
Скачать резервную копию проекта |
DELETE |
/api/integration/v1/backup/project/tasks/create/{taskId} |
Отменить задачу создания бэкапа |
POST |
/api/integration/v1/backup/project/upload |
Восстановить проект из файла резервной копии |
GET |
/api/integration/v1/backup/project/tasks/restore |
Получить ожидающие задачи восстановления |
DELETE |
/api/integration/v1/backup/project/tasks/restore/{taskId} |
Отменить задачу восстановления проекта из бэкапа |
| Метод | Путь | Описание |
|---|---|---|
GET |
/api/integration/v1/Quote/{projectId} |
Получить информацию о квоте проекта |
GET |
/api/integration/v1/Quote/ByVendor/{projectId} |
Получить квоту проекта по вендору |
GET |
/api/integration/v1/Quote/ListByProjectIds |
Получить список квот по списку проектов |
GET |
/api/integration/v1/Quote/List |
Получить список квот текущего аккаунта |
PUT |
/api/integration/v1/Quote/Update |
Обновить информацию о квоте проекта |
POST |
/api/integration/v1/Quote/{id}/Upload |
Загрузить файл квоты проекта |
POST |
/api/integration/v1/Quote/{id}/Approve |
Согласовать квоту |
POST |
/api/integration/v1/Quote/{id}/MarkAsPaid |
Пометить квоту как оплаченную |
GET |
/api/integration/v1/Quote/{id}/File |
Скачать файл расчёта стоимости |
| Метод | Путь | Описание |
|---|---|---|
GET |
/api/integration/v1/segment-confirmation-statistics/{projectId} |
Получить статистику подтверждения сегментов проекта |
GET |
/api/integration/v2/segment-confirmation-statistics/{projectId} |
Получить статистику подтверждения сегментов (v2) |
| Метод | Путь | Описание |
|---|---|---|
POST |
/api/integration/v1/smartTranslation/translate |
Получить перевод (умный перевод с выбором движка) |
| Метод | Путь | Описание |
|---|---|---|
GET |
/api/integration/v1/translationmemory/{tmId} |
Получить информацию о TM |
POST |
/api/integration/v1/translationmemory/{tmId} |
Импортировать TMX-файлы в TM |
DELETE |
/api/integration/v1/translationmemory/{tmId} |
Удалить TM |
GET |
/api/integration/v1/translationmemory |
Получить доступные TM аккаунта (с фильтрами) |
POST |
/api/integration/v1/translationmemory |
Создать пустую TM |
GET |
/api/integration/v1/translationmemory/task |
Получить список задач импорта TMX-файлов |
GET |
/api/integration/v1/translationmemory/{tmId}/file |
Экспортировать TMX-файлы из базы TM |
POST |
/api/integration/v1/translationmemory/matches |
Получить совпадения из указанной TM |
PUT |
/api/integration/v1/translationmemory/{tmId}/targets |
Добавить массив целевых языков в TM |
DELETE |
/api/integration/v1/translationmemory/task/{taskId} |
Удалить задачу импорта |
| Метод | Путь | Описание |
|---|---|---|
GET |
/api/integration/v1/vendor/list |
Получить список вендоров |
GET |
/api/integration/v1/vendor/{vendorAccountId} |
Получить вендора по ID |