Версіонування

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

Усе, що може зламати робочу інтеграцію (видалення чи перейменування поля, зміна типу, перетворення необов’язкового поля на обов’язкове), виходить у новій версії. Ми попереджаємо про це щонайменше за шість місяців, і весь цей час v1 продовжує працювати.

Усі зміни перелічено в Журналі змін.

Попередній POS API

Інтеграції, побудовані на https://loyaltyfy.io/api/pos/v1, продовжують працювати. Для нових інтеграцій використовуйте /api/v1: він приймає ті самі поля card_number і gross_amount, працює з усіма типами програм, а не лише з кешбеком, і додає вебхуки, ключі ідемпотентності та права.