Bu kılavuzda, Merchant API'nin sürüm oluşturma, sürümler ve farklı sürümlerinin yaşam döngüsünü nasıl yönettiği açıklanmaktadır.
Sürüm oluşturma şeması
Merchant API, alt API düzeyinde bir sürüm oluşturma stratejisi kullanır. Bu, her Merchant API'nin (ör. Merchant API'deki ürünler) kendi sürüm yaşam döngüsüne sahip olacağı anlamına gelir.
Sürüm oluşturma biçimi ve sunumu
Kararlı alt API sürümleri: Bir alt API kararlı sürümdeyse tüm yöntemleri de kararlı sürümde olur. Kararlı bir alt API sürümü vX (ör. v1, v2) olarak gösterilir. Bunlar, üretime hazır ana sürümlerdir.
Alfa alt API sürümleri: Bir alt API alfa sürümündeyse tüm yöntemleri de alfa sürümündedir. Alfa alt API sürümü, vXalpha (ör. v1alpha, v2alpha) olarak gösterilir. Bu sürümler, test ve hızlı iterasyon için tasarlanmış deneysel, erken erişim özellikleri içerir. Alfa sürümlerinde kararlılık garantisi yoktur, tanımlanmış bir kullanım ömrü yoktur ve 30 günlük bildirim süresiyle değiştirilebilir veya kullanımdan kaldırılabilir.
Sürüm değişiklikleri
- Ana sürüm artışları (örneğin, v1'den v2'ye): Bunlar, geriye dönük uyumsuz ve zarar veren değişiklikleri gösterir. Bu değişiklikler için geliştiricinin işlem yapması gerekir. Yalnızca kararlı alt API'lerin zarar veren değişiklikleri yeni bir sürüm numarasına sahip olur. Örneğin, v1'den v2'ye.
- Küçük değişiklikler: Geriye dönük uyumlu eklemeler veya düzeltmeler, mevcut ana sürümde yapılan değişiklikler olarak sunulur. Bu tür değişiklikler, ilgili ana sürümün sürüm notlarında ayrıntılı olarak açıklanır. Bir alt API'ye yapılan ve kesintiye neden olmayan eklemeler, en son kararlı sürümün alfa kanalında veya doğrudan en son kararlı sürümde yayınlanır.
Gün batımı politikası
Eski Merchant alt API sürümlerini periyodik olarak kullanımdan kaldırıyoruz. Kararlı ana sürümler (vX) için resmi kullanımdan kaldırma duyurusundan itibaren 12 aylık bir kullanımdan kaldırma süresi taahhüt ediyoruz.
Örneğin, Products alt API'sinin 1. sürümünün desteğini 15 Ocak 2026'da sonlandırırsak bu sürüm 15 Ocak 2027'den önce kullanımdan kaldırılmaz. Bu tarihten sonra alt API'nin önceki sürümü kullanılamayacak.
Alt API sürümü ve yaşam döngüsü durumu
Aşağıdaki tabloda, Merchant API'nin her bir alt API'sinin en yeni sürümleri listelenmiştir:
| Alt API | Sürümler | Durum |
|---|---|---|
| Hesaplar | v1 v1alpha |
Etkin Etkin |
| Dönüşümler | v1 | Etkin |
| Veri kaynakları | v1 | Etkin |
| Envanterler | v1 | Etkin |
| Sorun çözümü | v1 | Etkin |
| Yerel feed'ler iş ortaklığı | v1 | Etkin |
| Bildirimler | v1 | Etkin |
| Sipariş takibi | v1 | Etkin |
| Ürünler | v1 | Etkin |
| Product Studio | v1alpha | Etkin |
| Tanıtımlar | v1 | Etkin |
| Kota | v1 | Etkin |
| Raporlar | v1 | Etkin |
| Yorumlar | v1alpha | Etkin |
En iyi uygulamalar
- Yeni sürümler, önemli güncellemeler, iyileştirmeler ve alt API lansmanları ile kullanımdan kaldırma işlemleriyle ilgili duyurular için sürüm notlarını ve en son güncellemeleri düzenli olarak kontrol edin.
- Bir alt API'nin iki veya daha fazla kararlı sürümü varsa her zaman en son sürümü kullanmanızı öneririz.
- Uygulamanızı, ağ sorunları, sıklık sınırlamaları ve daha yeni alt API sürümleriyle sunulabilecek yeni hata kodları veya mesajlar dahil olmak üzere çeşitli alt API hatalarını sorunsuz bir şekilde işleyecek şekilde tasarlayın.
- Yükseltme planlamanızı yapmak için alt API sürümünün kullanımdan kaldırılmasını beklemeyin. Yeni sürümleri kullanıma sunulur sunulmaz değerlendirmeye ve test etmeye başlayın.
- Özellik istekleri veya alt API yol haritasıyla ilgili endişeleriniz için sorularınızı veya geri bildirimlerinizi bize iletin. Teknik destek için Merchant API ekibiyle nasıl iletişime geçeceğiniz hakkında bilgi edinmek istiyorsanız Merchant API ile ilgili yardım alma başlıklı makaleyi inceleyin.