Управление версиями

В этом руководстве объясняется, как API Merchant управляет версиями, выпусками и жизненным циклом различных версий.

Схема управления версиями

Merchant API использует стратегию управления версиями на уровне под-API. Это означает, что отдельные компоненты или сервисы в Merchant API будут иметь свой собственный жизненный цикл версий.

Формат и представление версий

  • Стабильные версии sub-API: Если sub-API находится в стабильной версии, то все его методы находятся в стабильной версии. Стабильная версия sub-API представлена ​​как vX (например, v1, v2). Это готовые к производству основные версии.

  • Версии альфа-под-API: Если под-API находится в альфа-версии, то все его методы находятся в альфа-версии. Версия альфа-под-API представлена ​​как vXalpha (например, v1alpha, v2alpha). Это ранние экспериментальные версии, предназначенные для тестирования и быстрой итерации. Альфа-версии не имеют гарантии стабильности и не имеют гарантированного срока службы. Альфа-версии могут быть изменены или прекращены с уведомлением за 30 дней.

Изменения версии

  • Основные приращения версии (например, v1 до v2): Они сигнализируют об обратно несовместимых и критических изменениях, которые требуют действий разработчика. Только критические изменения стабильных суб-API будут иметь новый номер версии. Например, v1 до v2.

  • Незначительные изменения: обратно совместимые дополнения или исправления представлены как изменения в существующей основной версии. Такие изменения будут подробно описаны в примечаниях к выпуску для этой основной версии. Неломающие дополнения к под-API будут выпущены в альфа-канал последней стабильной версии или непосредственно в последнюю стабильную версию.

Закаты

Мы периодически прекращаем поддержку старых версий Merchant sub-API. Мы обязуемся установить 12-месячный период устаревания для стабильных основных версий (vX), начиная с официального объявления об устаревании.

Например, если мы прекратим поддержку v1 под-API Products 15 января 2026 года, то ее поддержка прекратится не ранее 15 января 2027 года. После этой даты более ранняя версия под-API больше не будет доступна для использования.

Версия Sub-API и статус жизненного цикла

В следующей таблице перечислены последние версии каждого под-API API Merchant:

Суб-API Альфа версии Бета-версии Статус
Счета Нет в наличии v1 бета Активна бета-версия v1
Продукция Нет в наличии v1 бета Активна бета-версия v1
Вводные данные продукта Нет в наличии v1 бета Активна бета-версия v1
Местные запасы Нет в наличии v1 бета Активна бета-версия v1
Региональные инвентаризации Нет в наличии v1 бета Активна бета-версия v1
Источники данных Нет в наличии v1 бета Активна бета-версия v1
Акции Нет в наличии v1 бета Активна бета-версия v1
Отчеты Нет в наличии v1 бета Активна бета-версия v1
Конверсии Нет в наличии v1 бета Активна бета-версия v1
Уведомления Нет в наличии v1 бета Активна бета-версия v1
Обзоры Нет в наличии v1 бета Активна бета-версия v1
Настройки доставки Нет в наличии v1 бета Активна бета-версия v1
Студия продукта v1 альфа Нет в наличии Активна альфа-версия v1

Лучшие практики

  • Регулярно проверяйте заметки о выпуске и последние обновления на предмет новых версий, крупных обновлений, улучшений и объявлений о запуске и прекращении поддержки суб-API.
  • Если у под-API есть 2 или более стабильных версий, мы рекомендуем всегда использовать последнюю версию.
  • Разработайте приложение так, чтобы оно корректно обрабатывало различные ошибки sub-API, включая сетевые проблемы, ограничения скорости и новые коды ошибок или сообщения, которые могут появиться в новых версиях sub-API.
  • Не ждите, пока версия sub-API подойдет к концу, чтобы начать планировать обновление. Начните оценивать и тестировать новые версии, как только они станут доступны.
  • Для запросов функций или проблем с дорожной картой sub-API обращайтесь к нам с вопросами или отзывами . Информацию о том, как связаться с командой Merchant API для получения технической поддержки, см. в разделе Получить помощь с Merchant API .