Версии API

Версия входит в путь: /v1. В рамках v1 мы только добавляем новое.

Изменения, которые мы вносим в v1 без предупреждения: новые эндпоинты, новые необязательные поля запроса, новые поля в ответах, новые типы событий, новые значения в полях, описанных как открытые списки (например, mechanic или history_entry.type), новые коды ошибок. Пишите код так, чтобы неизвестные поля и значения игнорировались, а не вызывали ошибку.

Всё, что может сломать работающую интеграцию (удаление или переименование поля, смена типа, превращение необязательного поля в обязательное), выходит только в новой версии. Мы объявляем об этом минимум за шесть месяцев, и всё это время v1 продолжает работать.

Все изменения перечислены в истории изменений.

Прежний POS API

Интеграции на https://loyaltyfy.io/api/pos/v1 продолжают работать. Новые интеграции стоит строить на /api/v1: он принимает те же поля card_number и gross_amount, работает с программами любого типа, а не только с кэшбэком, и добавляет вебхуки, ключи идемпотентности и права ключей.