In diesem Leitfaden wird erläutert, wie die Merchant API die Versionsverwaltung, Releases und den Lebenszyklus der verschiedenen Versionen handhabt.
Versionsverwaltungsschema
Die Merchant API verwendet eine Versionsstrategie auf Sub-API-Ebene. Das bedeutet, dass jede Merchant API, z. B. „Products“ in der Merchant API, einen eigenen Versionslebenszyklus hat.
Format und Darstellung der Versionsverwaltung
Stabile Sub-API-Versionen: Wenn eine Sub-API in einer stabilen Version vorliegt, sind alle ihre Methoden in einer stabilen Version. Eine stabile Sub-API-Version wird als vX dargestellt (z. B. v1, v2). Dies sind produktionsreife Hauptversionen.
Alpha-Sub-API-Versionen: Wenn sich eine Sub-API in der Alphaphase befindet, befinden sich alle ihre Methoden in der Alphaphase. Eine Alpha-Sub-API-Version wird als vXalpha dargestellt (z. B. v1alpha, v2alpha). Sie enthalten experimentelle Early Access-Funktionen, die für Tests und schnelle Iterationen gedacht sind. Alpha-Versionen bieten keine Stabilitätsgarantie, haben keine definierte Lebensdauer und können mit einer Frist von 30 Tagen geändert oder eingestellt werden.
Versionsänderungen
- Erhöhung der Hauptversionsnummer (z. B. v1 auf v2): Diese weisen auf abwärtsinkompatible und funktionsgefährdende Änderungen hin, die Maßnahmen seitens der Entwickler erfordern. Nur funktionsgefährdende Änderungen an stabilen Sub-APIs erhalten eine neue Versionsnummer. Beispiel: v1 zu v2.
- Kleinere Änderungen: Abwärtskompatible Ergänzungen oder Korrekturen werden als Änderungen an der vorhandenen Hauptversion dargestellt. Solche Änderungen werden in den Versionshinweisen für die jeweilige Hauptversion beschrieben. Nicht funktionsgefährdende Ergänzungen einer Sub-API werden im Alpha-Kanal der neuesten stabilen Version oder direkt in der neuesten stabilen Version veröffentlicht.
Richtlinie zur Einstellung
Wir stellen ältere Versionen der Merchant-Sub-API regelmäßig ein. Wir verpflichten uns zu einem 12-monatigen Einstellungszeitraum für stabile Hauptversionen (vX), beginnend mit der offiziellen Ankündigung der Einstellung.
Wenn wir beispielsweise am 15. Januar 2026 die Version 1 der Products-Sub-API einstellen, wird sie frühestens am 15. Januar 2027 eingestellt. Nach diesem Datum ist die frühere Version der Sub-API nicht mehr verfügbar.
Sub-API-Version und Lebenszyklusstatus
In der folgenden Tabelle sind die aktuellen Versionen der einzelnen Unter-APIs der Merchant API aufgeführt:
| Sub-API | Versionen | Status |
|---|---|---|
| Konten | v1 v1alpha |
Aktiv Aktiv |
| Conversions | v1 | Aktiv |
| Datenquellen | v1 | Aktiv |
| Inventare | v1 | Aktiv |
| Problembehebung | v1 | Aktiv |
| Partnerprogramm für lokale Feeds | v1 | Aktiv |
| Benachrichtigungen | v1 | Aktiv |
| Bestellverfolgung | v1 | Aktiv |
| Produkte | v1 | Aktiv |
| Product Studio | v1alpha | Aktiv |
| Werbung | v1 | Aktiv |
| Kontingent | v1 | Aktiv |
| Berichte | v1 | Aktiv |
| Rezensionen | v1alpha | Aktiv |
Best Practices
- Sehen Sie sich regelmäßig die Versionshinweise und die neuesten Updates an, um Informationen zu neuen Versionen, wichtigen Updates, Verbesserungen und Ankündigungen zu neuen und eingestellten Sub-APIs zu erhalten.
- Wenn eine Sub-API zwei oder mehr stabile Versionen hat, empfehlen wir, immer die neueste Version zu verwenden.
- Entwerfen Sie Ihre Anwendung so, dass sie verschiedene Sub-API-Fehler ordnungsgemäß verarbeitet, einschließlich Netzwerkproblemen, Ratenbegrenzungen und neuen Fehlercodes oder ‑meldungen, die mit neueren Sub-API-Versionen eingeführt werden könnten.
- Warten Sie nicht, bis eine Sub-API-Version eingestellt wird, um mit der Planung Ihres Upgrades zu beginnen. Beginnen Sie mit der Bewertung und dem Testen neuer Versionen, sobald sie verfügbar sind.
- Wenn Sie Feature Requests oder Bedenken bezüglich der Roadmap einer Sub-API haben, wenden Sie sich mit Fragen oder Feedback an uns. Informationen dazu, wie Sie das Merchant API-Team für technischen Support kontaktieren können, finden Sie unter Hilfe zur Merchant API.