Версии и совместимость
Какие изменения API считаются совместимыми и как объявляются несовместимые.
Версия API — часть адреса: https://api.skystream.su/app/v1. Внутри версии API меняется только совместимо.
Совместимые изменения
Эти изменения вносятся в текущую версию без предупреждения. Интеграция должна быть к ним готова:
- новые операции;
- новые необязательные поля в запросах;
- новые поля в ответах;
- новые значения в перечислениях ответов: например, новый вид заказа или новый тип операции;
- новые коды ошибок;
- уточнение текста в
message.
Поэтому не отклоняйте ответ с незнакомым полем, обрабатывайте незнакомое значение перечисления как «прочее», а незнакомый код ошибки — по его классу type.
Несовместимые изменения
Удаление операции или поля, смена смысла поля, новое обязательное поле в запросе, смена кода ошибки для прежней ситуации — только в новой версии, v2. Прежняя версия после выхода новой работает не меньше шести месяцев. Ответы прежней версии в этот срок содержат заголовки Deprecation и Sunset с датой отключения.
Все изменения API перечислены в списке изменений.