В этом руководстве рассказывается, как в Merchant API обрабатывается управление версиями, выпуски и жизненный цикл разных версий.
Схема нумерации версий
В Merchant API используется стратегия управления версиями на уровне дочерних API. Это означает, что у каждого Merchant API, например Products в Merchant API, будет свой жизненный цикл версий.
Формат и представление версий
Стабильные версии дочерних API. Если дочерний API имеет стабильную версию, то все его методы также стабильны. Стабильная версия дочернего API обозначается как vX (например, v1, v2). Это основные версии, готовые к использованию в рабочей среде.
Альфа-версии дочерних API. Если дочерний API находится на стадии альфа-тестирования, то все его методы также находятся на этой стадии. Альфа-версия дополнительного API обозначается как vXalpha (например, v1alpha, v2alpha). Они содержат экспериментальные функции, доступные в рамках раннего доступа и предназначенные для тестирования и быстрой итерации. Для альфа-версий не гарантируется стабильность, не определен срок действия, и они могут быть изменены или прекращены с уведомлением за 30 дней.
Изменения версии
- Увеличение номера основной версии (например, с v1 до v2). Это означает, что в API внесены обратно несовместимые и критические изменения, которые требуют действий со стороны разработчика. Новый номер версии получат только критические изменения стабильных дополнительных API. например с версии 1 на версию 2.
- Незначительные изменения. Обратно совместимые дополнения или исправления представлены как изменения в существующей основной версии. Такие изменения будут подробно описаны в примечаниях к выпуску основной версии. Дополнения, не нарушающие работу дочернего API, будут выпускаться в альфа-канале последней стабильной версии или непосредственно в последней стабильной версии.
Правила прекращения поддержки
Мы периодически прекращаем поддержку старых версий Merchant sub-API. Мы обязуемся поддерживать стабильные основные версии (vX) в течение 12 месяцев с момента официального объявления о прекращении поддержки.
Например, если мы прекратим поддержку версии 1 дополнительного API Products 15 января 2026 года, то она будет отключена не ранее 15 января 2027 года. После этой даты более ранняя версия дочернего API станет недоступна.
Версия и статус жизненного цикла дочернего API
В таблице ниже перечислены последние версии каждого дочернего API Merchant API.
| Дополнительный API | Версии | Статус |
|---|---|---|
| Аккаунты | v1 v1alpha |
Активно Активно |
| Конверсии | v1 | Активно |
| Источники данных | v1 | Активно |
| Инвентарь | v1 | Активно |
| Решение проблем | v1 | Активно |
| Партнерство по фидам местного ассортимента | v1 | Активно |
| Уведомления | v1 | Активно |
| Отслеживание заказов | v1 | Активно |
| Товары | v1 | Активно |
| Product Studio | v1alpha | Активно |
| промоакции; | v1 | Активно |
| Квота | v1 | Активно |
| Отчеты | v1 | Активно |
| Отзывы | v1alpha | Активно |
Рекомендации
- Регулярно проверяйте примечания к выпуску и последние обновления, чтобы узнавать о новых версиях, крупных обновлениях, улучшениях и объявлениях о запуске и прекращении поддержки дочерних API.
- Если у дочернего API есть две или более стабильных версий, мы рекомендуем всегда использовать последнюю из них.
- Разработайте приложение так, чтобы оно корректно обрабатывало различные ошибки дочерних API, включая проблемы с сетью, ограничения частоты запросов и новые коды ошибок или сообщения, которые могут появиться в новых версиях дочерних API.
- Не ждите, пока поддержка версии дочернего API будет прекращена. Начните планировать обновление заранее. Начните оценивать и тестировать новые версии, как только они станут доступны.
- Если у вас есть запросы на добавление функций или вопросы по поводу плана развития дочерних API, свяжитесь с нами. Если вам нужна техническая поддержка, обратитесь к команде Merchant API.