Sürümleme
Mağaza API'sinde neyin kırıcı değişiklik sayıldığı ve hikie'nin bunu nasıl duyurduğu.
Mağaza API'sinin sürümü adresindeki ana numarayla belirlenir:
https://api.hikie.space/v1. Bu sayfalardaki her şey v1'dir.
Webhook'ların sürümü ayrıdır ve Hikie-Api-Version başlığıyla belirlenir. Bkz.
webhook sürüm politikası.
Sizi bozmayan değişiklikler
hikie bunları v1 içinde her zaman, haber vermeden yapabilir. İstemcinizi hiçbirinin onu bozmayacağı şekilde yazın.
- Yeni endpoint'ler ve yeni isteğe bağlı istek alanları.
- Yanıtlarda yeni alanlar.
status,kindya daerrorCodegibi bir değer kümesi tutan alanlarda yeni değerler.- Yeni izinler. Mevcut anahtarlar bunları kazanmaz.
messagemetninde değişiklikler.- Alanların ya da sıralamadığınız liste öğelerinin sırasında değişiklik.
İstemciniz tanımadığı yanıt alanlarını yok saymalı ve bilinmeyen bir status
ya da errorCode değerinde hata vermemelidir. Bilinmeyen değeri genel bir
başarısızlık ya da genel bir durum olarak ele alın.
Kırıcı değişiklikler
Bunlar mevcut bir entegrasyonu bozabilir ve aşağıdaki süreç olmadan v1 içinde asla yapılmaz:
- Bir ucu, alanı ya da izni kaldırmak veya yeniden adlandırmak.
- Bir alanın türünü ya da anlamını değiştirmek.
- İsteğe bağlı bir istek alanını zorunlu yapmak ya da daha önce kabul edilen değerleri reddetmek.
- Mevcut bir endpoint için farklı bir izin istemek.
- Günlük ürün sınırı ya da en büyük sayfa boyutu gibi belgelenmiş bir sınırı düşürmek.
- Mevcut bir durum için döndürülen
errorCode'u ya da HTTP durumunu değiştirmek.
Kırıcı değişiklik nasıl duyurulur
- Değişiklik önce değişiklik günlüğünde yayımlanır: neyin değiştiği, kimi etkilediği, yeni davranış ve eski davranışın biteceği tarih.
- hikie, etkilenen ucu önceki 90 günde kullanan her mağazanın sahibine e-posta gönderir ve panelde bir bildirim gösterir.
- Etkilenen davranış, duyurudan sonra en az 90 gün çalışmaya devam eder.
- Yerine geçen davranış duyuru gününden itibaren kullanılabilir; böylece bildirim süresi içinde geçiş yapabilirsiniz.
Bir güvenlik sorununu gidermek için gereken değişiklik daha erken yapılabilir. Bunlar mümkün olan en kısa sürede değişiklik günlüğünde duyurulur.
Bir değişiklik v1 içinde yapılamayacak kadar büyükse /v2 olarak yayımlanır. v1 ve
v2 yan yana çalışır ve v1 kaldırılmadan önce aynı bildirim kurallarına uyar.
Ön sürüm davranışı
Bu sayfalarda beta olarak işaretlenen endpoint'ler ya da alanlar yukarıdaki bildirim olmadan değişebilir. Mağaza API'sinde bugün beta işaretli bir şey yoktur.