Что такое интеграционный API
Интеграционный API платформы — REST-интерфейс, который позволяет автоматизировать все основные процессы: создание проектов и загрузку файлов, экспорт результатов, управление TM и глоссариями, клиентами, счетами и платежами.
API спроектирован как полноценный аналог интерфейса — через него можно построить автоматическую локализацию «под ключ».
Базовые сведения
| Параметр | Значение |
|---|---|
| Базовый URL | https://app.plaia.ru/api/integration/v1 (есть v2 и v3 для части методов) |
| Формат | REST, JSON |
| Авторизация | HTTP Basic: accountId + API-токен (Аутентификация) |
| Swagger | app.plaia.ru/api/methods |
| Справочник на русском | /api (эта справка) |
Группы методов
- Account — данные аккаунта, MT-движки.
- Project / Document / DocumentExport — проекты, документы, экспорт.
- TranslationMemories / Glossary — лингвистические активы.
- Client / ClientIndustry / Vendor / MyTeam — заказчики, подрядчики, команда.
- Invoice / Quote / LspPrices / LspService — биллинг.
- Callback — вебхуки о событиях.
- Placeholders / Directories / FileDisassemblingAlgorithmPresets — настройки.
- SmartTranslation — прямой умный перевод.
Версии
Методы существуют в v1 и v2/v3: v2/v3 — обновлённые контракты (например, project/list v2 с пагинацией). Устаревшие (obsolete) методы помечены в Swagger — используйте новые версии.
Что дальше
- Аутентификация в API — как подписывать запросы.
- Первый запрос к API — hello-world за минуту.
- Проекты через API — типовой сценарий автоматизации.