Совместимость и изменения¶
На что можно опираться, строя интеграцию с Ziex Try-On, и что менялось. Прочитайте эту страницу, прежде чем зафиксировать версию, и ещё раз, когда планируете обновление.
Политика совместимости¶
API: /api/v1¶
Внутри /api/v1 API меняется только аддитивно:
- Новые необязательные поля запроса, новые поля ответа, новые заголовки и новые эндпоинты могут появляться в любой момент. Пишите клиент так, чтобы он игнорировал неизвестное.
- Новый код ошибки появляется только для нового условия. Конверт ошибки и смысл любого существующего кода не меняются. См. Ошибки.
- Ужесточение документированного лимита или таймаута — это breaking change. Ослабление — аддитивное изменение. См. Лимиты.
- Удаления и переименования происходят только в новой мажорной версии,
/api/v2.
Виджет¶
- Виджет — это один URL,
https://api.ziex-tryon.com/embed/tryon-embed.js.TryOn.version— семантическая версия. - Внутри мажорной версии опции и события только добавляются: могут появиться новые необязательные опции и новые события, существующие сохраняют смысл. См. Справочник по виджету.
- Breaking-изменение виджета публикуется по новому адресу,
/embed/v2/. Этот адрес зарезервирован и сегодня не существует.
Заморожено в версии 1¶
Эти части не изменятся внутри версии 1, потому что их читает другой код (плагин, загрузчик, правило CSS):
| Что | Как заморожено |
|---|---|
| Слот подхвата | Ключ sessionStorage ziex-tryon:attempt: и следом хеш FNV-1a 32 бита от публикуемого ключа в виде 8 шестнадцатеричных цифр |
| Запись подхвата | Её форма, v: 1 |
| Флаг готовности | html[data-tryon-ready] со значением result или error |
Событие ready |
Его данные {job_id, kind, background} |
| Загрузчик | ZiexTryOn.hasPending(pk) и ZiexTryOn.load([scriptUrl]) |
О том, как их использует плагин, — в Отложенной загрузке и подхвате.
Снятие с поддержки¶
Всё, что мы перестаём поддерживать, анонсируется на этой странице не менее чем за 90 дней до удаления.
Машиночитаемая спецификация¶
Документ OpenAPI лежит по адресу https://api.ziex-tryon.com/api/v1/openapi.json. Его info.version — версия
спецификации (сейчас 1.1.0), а info.x-changelog перечисляет изменения каждой версии. Отрисованные страницы — в
Справочнике API.
Список изменений¶
Спецификация API¶
1.1.0 — 2026-10-26¶
Первая опубликованная спецификация. Она описывает каждый статус ошибки с его кодами, заголовки запросов и ответов,
документ capabilities и вебхуки. Это та же запись, что info.x-changelog в документе OpenAPI.
Виджет¶
1.2.0 — 2026-10-23¶
Когда сервер отвечает 503 с кодом OVERLOADED, задачи нет и ничего не списано. Теперь виджет отправляет POST снова
с тем же Idempotency-Key, до 3 раз в течение 60 секунд, и показывает сообщение об ожидании. См.
Занятый сервер и Лимиты.
1.1.0 — 2026-10-23¶
Новый дизайн окна. Новые опции theme, accent и launcherPosition. См. Справочник по виджету.