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