B2BB2CH2H

Версионирование

Версии методов/эндпоинтов обозначаются как v1 , v2 , v3 и так далее. Это позволяет явно указать, какую версию API использует клиент.

Мажорные изменения

Мажорные изменения подразумевают выпуск новой версии API. Они включают изменения, которые приводят к обратной несовместимости.

Примеры мажорных изменений:

  • добавление обязательных параметров в запрос;
  • удаление обязательных параметров из запроса или ответа;
  • трансформация необязательных параметров в обязательные;
  • изменение типа параметра в запросе или ответе.
Минорные изменения

Минорные изменения не требуют выпуска новой версии API. Они не нарушают обратную совместимость.

Примеры минорных изменений:

  • добавление новой функциональности без нарушения обратной совместимости;
  • исправление ошибок;
  • улучшение производительности;
  • дополнительные необязательные параметры в запросе или ответе.
Поддержание старой версии

Срок поддержки работы старой версии составляет от двух до шести месяцев. После этого срока Банк оставляет за собой право прекратить поддержку старой версии. При этом будет добавлено уведомление о прекращении поддержки старой версии эндпоинта.

Тестирование на песочнице

Переход на новую версию обязательно должен включать тестирование на песочнице (тестовой среде).