Sürümleme

Sürüm yolun bir parçasıdır: /v1. v1 içinde yalnızca ekleme yaparız.

v1'de önceden haber vermeden yapabileceğimiz değişiklikler: yeni uç noktalar, istekte yeni isteğe bağlı alanlar, yanıtlarda yeni alanlar, yeni olay türleri, açık liste olarak belgelenen alanlarda yeni değerler (mechanic veya history_entry.type gibi), yeni hata kodları. Kodunuzu bilinmeyen alan ve değerleri reddetmeyecek, yok sayacak şekilde yazın.

Çalışan bir entegrasyonu bozabilecek her değişiklik (bir alanı kaldırmak veya yeniden adlandırmak, türünü değiştirmek, isteğe bağlı bir alanı zorunlu yapmak) yeni sürümde yapılır. Bunu en az altı ay önceden duyururuz ve bu süre boyunca v1 çalışmaya devam eder.

Tüm değişiklikler Değişiklik günlüğü sayfasında listelenir.

Önceki POS API

https://loyaltyfy.io/api/pos/v1 üzerine kurulu entegrasyonlar çalışmaya devam eder. Yeni entegrasyonlarda /api/v1 kullanın: aynı card_number ve gross_amount alanlarını kabul eder, yalnızca cashback değil tüm program türleriyle çalışır, ayrıca webhook'lar, idempotency anahtarları ve izinler sunar.