In diesem Leitfaden wird erläutert, wie die Merchant API Versionierung, Releases und den Lebenszyklus der verschiedenen Versionen handhabt.
Versionsverwaltungsschema
Die Merchant API verwendet eine Versionierungsstrategie auf Sub-API-Ebene. Das bedeutet, dass einzelne Komponenten oder Dienste innerhalb der Merchant API ihren eigenen Versionszyklus haben.
Versionsformat und -präsentation
Stabile Sub-API-Versionen:Wenn eine Sub-API eine stabile Version hat, haben auch alle ihre Methoden eine stabile Version. Die stabile Sub-API-Version wird als „vX“ dargestellt (z. B. „v1“, „v2“). Dies sind produktionsreife Hauptversionen.
Alphaversionen von Unter-APIs:Wenn eine Unter-API in der Alphaversion ist, sind auch alle ihre Methoden in der Alphaversion. Die Alpha-Unter-API-Version wird als vXalpha dargestellt (z. B. v1alpha oder v2alpha). Dies sind experimentelle Early-Access-Versionen, die für Tests und schnelle Iterationen gedacht sind. Alphaversionen bieten keine Stabilitätsgarantie und haben keine garantierte Lebensdauer. Alphaversionen können mit einer Frist von 30 Tagen geändert oder eingestellt werden.
Versionsänderungen
Erhöhung der Hauptversion (z. B. von Version 1 auf Version 2): Dies sind nicht abwärtskompatible und funktionsgefährdende Änderungen, die vom Entwickler behoben werden müssen. Nur nicht abwärtskompatible Änderungen an stabilen Unter-APIs erhalten eine neue Versionsnummer. Beispiel: von v1 zu v2.
Nebenversionen: Abwärtskompatible Ergänzungen oder Fehlerkorrekturen werden als Änderungen an der vorhandenen Hauptversion dargestellt. Solche Änderungen werden in den Releasehinweisen für diese Hauptversion beschrieben. Erweiterungen einer Unter-API, die keine Unterbrechungen verursachen, werden im Alphakanal der neuesten stabilen Version oder direkt in der neuesten stabilen Version veröffentlicht.
Sonnenuntergänge
Ältere Versionen der Merchant-Unter-API werden in regelmäßigen Abständen eingestellt. Wir verpflichten uns zu einer 12-monatigen Frist für die Einstellung stabiler Hauptversionen (vX), beginnend mit der offiziellen Ankündigung der Einstellung.
Wenn wir beispielsweise Version 1 der Products-Unter-API am 15. Januar 2026 verwerfen, wird sie frühestens am 15. Januar 2027 eingestellt. Danach ist die ältere Version der Unter-API nicht mehr verfügbar.
Sub-API-Version und Lebenszyklusstatus
In der folgenden Tabelle sind die neuesten Versionen der einzelnen Unter-APIs der Merchant API aufgeführt:
| Sub-API | Alphaversionen | Betaversionen | Status |
|---|---|---|---|
| Konten | Nicht verfügbar | Version 1 Beta | Betaversion 1 ist aktiv |
| Produkte | Nicht verfügbar | Version 1 Beta | Die Betaversion 1 ist aktiv |
| Produkteingaben | Nicht verfügbar | Version 1 Beta | Betaversion 1 ist aktiv |
| Lokales Inventare | Nicht verfügbar | Version 1 Beta | Die Betaversion 1 ist aktiv |
| Regionale Inventare | Nicht verfügbar | Version 1 Beta | Die Betaversion 1 ist aktiv |
| Datenquellen | Nicht verfügbar | Version 1 Beta | Betaversion 1 ist aktiv |
| Werbeaktionen | Nicht verfügbar | Version 1 Beta | Betaversion 1 ist aktiv |
| Berichte | Nicht verfügbar | Version 1 Beta | Die Betaversion 1 ist aktiv |
| Conversions | Nicht verfügbar | Version 1 Beta | Die Betaversion 1 ist aktiv |
| Benachrichtigungen | Nicht verfügbar | Version 1 Beta | Die Betaversion 1 ist aktiv |
| Rezensionen | Nicht verfügbar | Version 1 Beta | Betaversion 1 ist aktiv |
| Versandeinstellungen | Nicht verfügbar | Version 1 Beta | Betaversion 1 ist aktiv |
| Product Studio | v1 alpha | Nicht verfügbar | Alphaversion v1 ist aktiv |
Best Practices
- Lesen Sie regelmäßig die Versionshinweise und die aktuellen Updates, um über neue Versionen, wichtige Updates, Verbesserungen und Ankündigungen zu Einführungen und Einstellungen von Unter-APIs informiert zu bleiben.
- Wenn eine untergeordnete API zwei oder mehr stabile Versionen hat, empfehlen wir, immer die neueste Version zu verwenden.
- Ihre Anwendung sollte verschiedene Sub-API-Fehler fehlerfrei verarbeiten, einschließlich Netzwerkproblemen, Ratenbeschränkungen und neuer Fehlercodes oder ‑meldungen, die mit neueren Sub-API-Versionen eingeführt werden könnten.
- Warten Sie nicht, bis eine Sub-API-Version eingestellt wird, bevor Sie mit der Planung Ihres Upgrades beginnen. Beginnen Sie mit der Bewertung und dem Testen neuer Versionen, sobald sie verfügbar sind.
- Wenn Sie Funktionsanfragen haben oder Bedenken bezüglich der Roadmap einer Sub-API äußern möchten, wenden Sie sich bitte an uns. Informationen dazu, wie Sie das Merchant API-Team für technischen Support kontaktieren, finden Sie unter Hilfe zur Merchant API.