Sürümlendirme

Partner API, URL'de sürümlendirilir. Geçerli sürüm şudur:

https://partner-api.performancehub.co/partner/v1/

Değişiklik ilkesi

Performance Hub, mümkün olan her yerde ekleme niteliğinde, geriye dönük uyumlu değişiklikler yapmayı amaçlar.

Geriye dönük uyumlu değişiklik örnekleri:

• Bir isteğe yeni bir isteğe bağlı alan eklemek.
• Bir yanıta yeni bir alan eklemek.
• Yeni bir uç nokta eklemek.
• İstemcilerin bilinmeyen değerleri işlemesinin beklendiği durumlarda yeni bir enum değeri eklemek.
• Durum kodu sözleşmesini değiştirmeden doğrulama mesajlarını iyileştirmek.

access_time_windows ve access_time_windows_revision, ekleme niteliğindeki Member istek alanlarıdır. Bunları göndermeyen mevcut istemciler, saklanan Access Time Window anlık görüntüsünü değiştirmeden korur. Bu gönderilmeme kuralı kısmi upsert uyumluluğunu korur; alanı göndermemek boş bir dizi göndermekle eşdeğer değildir.

Uyumluluğu bozan değişiklik örnekleri:

• Bir alanı kaldırmak veya yeniden adlandırmak.
• Bir alanın türünü değiştirmek.
• İsteğe bağlı bir istek alanını zorunlu hale getirmek.
• Bir uç noktayı kaldırmak.
• Mevcut bir durum kodunun veya alana özgü bir reason değerinin anlamını değiştirmek.

Kullanımdan kaldırmalar

Uyumluluğu bozan bir değişiklik gerektiğinde Performance Hub, mümkün olduğunca mevcut sürümü yerinde değiştirmekten kaçınır. Bunun yerine yeni bir sürüm veya geçiş yolu sunar ve değişikliği etkilenen iş ortaklarına bildiririz.

Kullanımdan kaldırma bildirimleri şunları içerebilir:

• Bir değişiklik günlüğü kaydı.
• Doğrudan iş ortağı iletişimi.
• Partner Console'daki notlar.
• Belgelerdeki geçiş yönergeleri.

İstemci önerileri

Ekleme niteliğindeki değişikliklere dayanıklı istemciler geliştirin:

• Kullanmadığınız yanıt alanlarını yok sayın.
• Bilinmeyen enum değerlerini çökmek yerine desteklenmeyen değerler olarak ele alın.
• Katı yanıt eşitliği kontrollerinden kaçının.
• Entegrasyonunuzu bilinçli olarak güncelleyebilmek için tanınmayan değerleri kaydedin.

Access Time Windows gibi revizyonlu Member bölümleri için gönderilen revizyonu ve normalleştirilmiş yükü sonuç bilinene kadar kalıcı olarak saklayın. Değişen içerik için bir revizyonu yeniden kullanmak bir çakışmadır; aynı içeriği yeniden oynatmak ise idempotent bir işlemdir. Access Time Windows bölümüne bakın.

OpenAPI belirtimleri

İstemci oluşturmak, istekleri doğrulamak ve API yapısındaki değişiklikleri zaman içinde izlemek için yayımlanan OpenAPI belirtimlerini kullanın.

OpenAPI Belirtimleri sayfasına bakın.