Panduan ini menjelaskan cara Merchant API menangani pembuatan versi, rilis, dan siklus proses berbagai versinya.
Skema pembuatan versi
Merchant API menggunakan strategi pembuatan versi di tingkat sub-API. Artinya, setiap Merchant API, misalnya Products dalam Merchant API, akan memiliki siklus proses versinya sendiri.
Format dan presentasi pembuatan versi
Versi sub-API stabil: Jika sub-API berada dalam versi stabil, semua metodenya berada dalam versi stabil. Versi sub-API yang stabil direpresentasikan sebagai vX (misalnya, v1, v2). Ini adalah versi utama yang siap produksi.
Versi sub-API alfa: Jika sub-API dalam versi alfa, semua metodenya juga dalam versi alfa. Versi sub-API alfa direpresentasikan sebagai vXalpha (misalnya, v1alpha, v2alpha). Saluran ini berisi fitur akses awal eksperimental yang ditujukan untuk pengujian dan iterasi cepat. Versi alfa tidak memiliki jaminan stabilitas, tidak memiliki masa aktif yang ditentukan, dan dapat diubah atau dihentikan dengan periode pemberitahuan 30 hari.
Perubahan versi
- Peningkatan versi utama (misalnya, v1 ke v2): Hal ini menandakan perubahan yang tidak kompatibel dengan versi sebelumnya dan perubahan yang dapat menyebabkan gangguan, yang memerlukan tindakan developer. Hanya perubahan yang dapat menyebabkan gangguan pada sub-API stabil yang akan memiliki nomor versi baru. Misalnya, v1 ke v2.
- Perubahan minor: Penambahan atau perbaikan yang kompatibel dengan versi lama ditampilkan sebagai perubahan pada versi utama yang ada. Perubahan tersebut akan dijelaskan dalam catatan rilis untuk versi utama tersebut. Penambahan yang tidak menyebabkan gangguan pada sub-API akan dirilis ke saluran alfa versi stabil terbaru atau langsung ke versi stabil terbaru.
Kebijakan penghentian
Kami menghentikan versi sub-API Merchant yang lebih lama secara berkala. Kami berkomitmen untuk memberikan periode penghentian penggunaan selama 12 bulan untuk versi utama yang stabil (vX), mulai dari pengumuman penghentian penggunaan resmi.
Misalnya, jika kami menghentikan penggunaan sub-API Products v1 pada 15 Januari 2026, sub-API tersebut akan dihentikan paling cepat pada 15 Januari 2027. Setelah tanggal ini, sub-API versi sebelumnya tidak akan tersedia lagi untuk digunakan.
Versi sub-API dan status siklus proses
Tabel berikut mencantumkan versi terbaru setiap sub-API Merchant API:
| Sub-API | Versi | Status |
|---|---|---|
| Akun | v1 v1alpha |
Aktif Aktif |
| Konversi | v1 | Aktif |
| Sumber data | v1 | Aktif |
| Inventaris | v1 | Aktif |
| Penyelesaian masalah | v1 | Aktif |
| Kemitraan feed lokal | v1 | Aktif |
| Notifikasi | v1 | Aktif |
| Pelacakan pesanan | v1 | Aktif |
| Produk | v1 | Aktif |
| Product Studio | v1alpha | Aktif |
| Promosi | v1 | Aktif |
| Kuota | v1 | Aktif |
| Laporan | v1 | Aktif |
| Ulasan | v1alpha | Aktif |
Praktik terbaik
- Periksa catatan rilis dan update terbaru secara rutin untuk mengetahui versi baru, update utama, peningkatan, dan pengumuman tentang peluncuran dan penghentian sub-API.
- Jika sub-API memiliki dua atau beberapa versi stabil, sebaiknya gunakan versi terbaru setiap saat.
- Desain aplikasi Anda untuk menangani berbagai error sub-API dengan baik, termasuk masalah jaringan, pembatasan kapasitas, dan kode atau pesan error baru yang mungkin diperkenalkan dengan versi sub-API yang lebih baru.
- Jangan menunggu hingga versi sub-API akan dihentikan untuk mulai merencanakan upgrade Anda. Mulai evaluasi dan uji versi baru segera setelah tersedia.
- Untuk permintaan fitur atau masalah terkait roadmap sub-API, hubungi kami dengan pertanyaan atau masukan. Untuk mengetahui informasi tentang cara menghubungi Tim API Merchant guna mendapatkan dukungan teknis, lihat Mendapatkan bantuan terkait Merchant API.