added
Модель ключа развертывания, где токен носителя И ЕСТЬ проект. На ней работают как CLI, так и действие GitHub.
api v1 · текущая версия
Журнал изменений API.
Ничего не удаляется.
/v1 только расширяется. Новые эндпоинты и поля ответов появляются в том же префиксе, а уже используемые поля никогда не меняют структуру и не исчезают. Критические изменения выпускаются под новым префиксом версии, который зарезервирован и пока пуст.
v1/api/v1
единственный используемый префикс
единственный используемый префикс
5 релизов
11 изменений, ни одного критического
структура журнала
Один префикс версии, без удалений.
Три из этих четырех параметров относятся к самому журналу. Четвертый — это размер каталога вебхуков, предоставляемых API.
5
релизы /v1, каждый из них добавляет функциональность
1
используемый префикс версии. Следующий зарезервирован и пуст
0
критических изменений с момента запуска API
12
подписанные события вебхуков. Источник: App\Enums\WebhookEvent
датировано по релизам, а не по semver
используйте клавиши со стрелками для навигации
2026-07-08
Доставка через CDN, использование и песочница
July 8, 2026 · 4 изменений
05 / 05
added
/v1/incontext/translations, /screenshots и /suggest обеспечивают работу визуального редактора, при этом CORS ограничен этим префиксом и ничем иным.
POST /v1/incontext/session обменивает публикуемый ключ и Origin на токен сессии с ограниченной областью действия.
improved
Двуязычный экспорт теперь сообщает о том, что не удалось обработать в обе стороны, вместо того чтобы молча подставлять исходный текст. Существующие поля остаются неизменными, что и является главной целью вынесения этой информации в заголовок.
GET /v1/pull получил заголовки ответа X-Skipped-Keys и X-Missing-Source-Keys.
added
А также /v1/glossary/import, /export и /extract, позволяющие перемещать базу терминов внутрь и наружу без открытия консоли.
Полный CRUD для базы терминов через API: GET, POST, PUT и DELETE для /v1/glossary.
added
Результаты проверки появляются в строках перевода, которые вы уже получаете, поэтому ничего нового опрашивать не нужно.
POST /v1/qa/run запускает агентную проверку качества и возвращает идентификатор выполнения.
added
Подписка настраивается для каждой конечной точки. Список находится в App\Enums\WebhookEvent, который сегодня содержит двенадцать вариантов; считайте элементы перечисления, а не эту строку.
Подписанные вебхуки отправляют события ключей, переводов, языков, глоссария и проверки качества вместе с оригинальной парой пакетов.
improved
Доставка содержит счетчик и до двадцати примеров вместо отдельного вызова для каждой измененной строки. Журналы доставки записывают каждую попытку со временем следующей повторной попытки.
Высокочастотные события, такие как translation.updated, объединяются в одну доставку за окно времени, поэтому массовое редактирование никогда не перегружает конечную точку.
added
Он возвращает ETag и краткосрочный кэш, а также поддерживает If-None-Match с кодом 304. Неизменяемая версия под /v{n} адресуется по содержимому и кэшируется на год.
Публичный GET-запрос /v1/cdn/{project}/{locale}, кэшируемый на граничных узлах, обслуживает ваши опубликованные строки.
added
Запускайте это в CI через POST /v1/cdn/publish и авторизуйте чтение с помощью специального ключа только для чтения в заголовке X-Transglot-Cdn-Key. Безопасно размещать за собственным CDN.
Публикация продвигает текущие переводы в новую неизменяемую версию, вручную или при каждом пуше.
added
Тела запросов не сохраняются. Это просто счетчик и ничего более.
Каждый аутентифицированный вызов /v1 учитывается по токенам за день и отображается на хабе развертывания.
improved
Проект, получение данных, пакеты и экспорт глоссария. Никакие структуры запросов или ответов не были изменены для обеспечения работы.
Хаб развертывания получил API-песочницу, которая выполняет read-only конечные точки в реальном времени для вашего проекта.
реестр устаревших функций
Ничего не будет удалено.
Одна строка на каждый опубликованный интерфейс с указанием релиза, в котором он появился. Последняя колонка — та, за которой нужно следить: удаление появилось бы там с датой задолго до самого события.
| Интерфейс | Выпущено | Статус | Дата удаления |
|---|---|---|---|
GET /v1/project · /pull · POST /push · /translate · GET /batches | April 2, 2026 | текущий | не запланировано |
POST /v1/incontext/session · /translations · /screenshots · /suggest | May 20, 2026 | текущий | не запланировано |
GET, POST, PUT, DELETE /v1/glossary · /import · /export · /extract | June 12, 2026 | текущий | не запланировано |
POST /v1/qa/run | June 12, 2026 | текущий | не запланировано |
Signed webhook events, twelve typed cases | June 30, 2026 | текущий | не запланировано |
GET /v1/cdn/{project}/{locale} · POST /v1/cdn/publish | July 8, 2026 | текущий | не запланировано |
Строки из этой таблицы никогда не удаляются. Если интерфейс выводится из эксплуатации, его строка сохраняется и дополняется датой, поскольку возможность спланировать удаление — главная цель публикации этого списка.
гарантия совместимости
Три правила на которые можно опираться.
аддитивность
Новые эндпоинты и поля ответов добавляются в рамках /v1. Поля, которые вы уже обрабатываете, не меняют структуру и не исчезают.
новый префикс
Критические изменения выпускаются под новым версионным префиксом, а не внутри текущего. Этот префикс зарезервирован и пока не используется; все релизы выше остаются на v1.
прозрачные заголовки
Если запрос не может полностью обработать данные, об этом сообщается в заголовке. Вместо изменения тела ответа были добавлены заголовки X-Skipped-Keys и X-Missing-Source-Keys.
Частые вопросы
Вопросы разработчиков о версионировании API и выводе функций из эксплуатации.
Версионируется ли API Transglot?
Да, по префиксу URL. Всё, что опубликовано на данный момент, находится под /v1 — это единственный используемый префикс. Нет ни заголовка версии, ни привязки к дате, ни дополнительных настроек.
Может ли обновление нарушить работу моей интеграции?
Не в рамках /v1. Новые эндпоинты и поля ответов добавляются, но поля, которые вы уже обрабатываете, не меняют структуру и не исчезают. Если изменение невозможно сделать аддитивно, оно выпускается под новым префиксом, а старый продолжает работать.
Было ли что-то выведено из эксплуатации или удалено?
Ничего, и реестр выше подтверждает это для каждой строки. Все опубликованные интерфейсы перечислены с указанием релиза, в котором они появились, а в колонке удаления везде указано «не запланировано».
За сколько времени предупреждают об удалении?
Удаление появляется в этом реестре с указанной датой задолго до самого события, а строка остаётся в таблице даже после него. Возможность спланировать действия по конкретной дате — главная цель публикации такого списка.
Как узнать о выходе новых функций?
Каждый релиз датирован на этой странице. Журнал изменений продукта охватывает всё остальное, а в консоли появляется маркер, если есть непрочитанные обновления.
Почему для API есть отдельный журнал изменений?
Потому что API несёт гарантию совместимости, которой нет у обычных релизов продукта. Разработчику, проверяющему работоспособность интеграции, не нужно пролистывать описание новых функций, чтобы найти нужную информацию.
Как добавить API в свой тарифный план?
Bearer-токен доступен начиная с тарифа Starter за $19 в месяц. Бесплатный тариф даёт доступ к консоли, но не позволяет создавать токены; CLI, GitHub Action, вебхуки и MCP работают только с этим токеном.
Где находится справка по самим эндпоинтам?
На странице API: аутентификация, эндпоинты, ограничение частоты запросов, форматы файлов и каталог вебхуков. Эта страница содержит только журнал изменений с указанием дат.
работает с тем, что вы уже используете
41 коннекторов уже готово.
контракт — это продукт
Создавайте на базе API который не меняется.
API доступен на тарифе Starter и выше. Бесплатный тариф стоит $0 и включает 100 000 слов для начала (25 000 при регистрации, 75 000 после проверки по телефону), затем 10 000 в месяц, без доступа к API и вебхукам.