Hướng dẫn này giải thích cách Merchant API xử lý việc tạo phiên bản, phát hành và vòng đời của các phiên bản.
Lược đồ phiên bản
Merchant API sử dụng chiến lược tạo phiên bản ở cấp độ API phụ. Điều này có nghĩa là các thành phần hoặc dịch vụ riêng lẻ trong Merchant API sẽ có vòng đời phiên bản riêng.
Định dạng và cách trình bày phiên bản
Phiên bản API phụ ổn định: Nếu một API phụ ở phiên bản ổn định, thì tất cả các phương thức của API đó đều ở phiên bản ổn định. Phiên bản API phụ ổn định được biểu thị là vX (ví dụ: v1, v2). Đây là các phiên bản chính đã sẵn sàng để phát hành công khai.
Phiên bản API phụ alpha: Nếu một API phụ đang ở phiên bản alpha, thì tất cả các phương thức của API đó đều ở phiên bản alpha. Phiên bản API phụ Alpha được biểu thị là vXalpha (ví dụ: v1alpha, v2alpha). Đây là các phiên bản thử nghiệm, sử dụng sớm dành cho việc kiểm thử và lặp lại nhanh. Phiên bản alpha không có tính năng đảm bảo độ ổn định và không có thời gian hoạt động được đảm bảo. Bạn có thể thay đổi hoặc ngừng cung cấp phiên bản Alpha sau khi thông báo 30 ngày.
Các lần thay đổi phiên bản
Tăng phiên bản chính (ví dụ: v1 lên v2): Những thay đổi này báo hiệu các thay đổi không tương thích ngược và gây lỗi, đòi hỏi nhà phát triển phải hành động. Chỉ những thay đổi có thể gây lỗi của các API phụ ổn định mới có số phiên bản mới. Ví dụ: v1 thành v2.
Thay đổi nhỏ: Các nội dung bổ sung hoặc bản sửa lỗi tương thích ngược được trình bày dưới dạng thay đổi đối với phiên bản lớn hiện có. Những thay đổi như vậy sẽ được nêu chi tiết trong ghi chú phát hành cho phiên bản chính đó. Các nội dung bổ sung không gây lỗi cho API phụ sẽ được phát hành cho kênh alpha của phiên bản ổn định mới nhất hoặc trực tiếp cho phiên bản ổn định mới nhất.
Hoàng hôn
Chúng tôi định kỳ ngừng cung cấp các phiên bản API phụ cũ của Người bán. Chúng tôi cam kết cung cấp khoảng thời gian ngừng sử dụng là 12 tháng cho các phiên bản chính ổn định (vX), kể từ thông báo chính thức về việc ngừng sử dụng.
Ví dụ: nếu chúng tôi ngừng sử dụng phiên bản 1 của API phụ Sản phẩm vào ngày 15 tháng 1 năm 2026, thì API này sẽ ngừng hoạt động muộn nhất vào ngày 15 tháng 1 năm 2027. Sau ngày này, bạn sẽ không thể sử dụng phiên bản cũ của API phụ nữa.
Phiên bản API phụ và trạng thái vòng đời
Bảng sau đây liệt kê các phiên bản mới nhất của từng API phụ của Merchant API:
| API phụ | Phiên bản alpha | Phiên bản thử nghiệm | Trạng thái |
|---|---|---|---|
| Tài khoản | Không có | phiên bản thử nghiệm v1 | Phiên bản beta v1 đang hoạt động |
| Sản phẩm | Không có | phiên bản thử nghiệm v1 | Phiên bản beta v1 đang hoạt động |
| Thông tin đầu vào về sản phẩm | Không có | phiên bản thử nghiệm v1 | Phiên bản beta v1 đang hoạt động |
| Kho hàng tại địa phương | Không có | phiên bản thử nghiệm v1 | Phiên bản beta v1 đang hoạt động |
| Kho hàng tại khu vực | Không có | phiên bản thử nghiệm v1 | Phiên bản beta v1 đang hoạt động |
| Nguồn dữ liệu | Không có | phiên bản thử nghiệm v1 | Phiên bản beta v1 đang hoạt động |
| Quảng cáo | Không có | phiên bản thử nghiệm v1 | Phiên bản beta v1 đang hoạt động |
| Báo cáo | Không có | phiên bản thử nghiệm v1 | Phiên bản beta v1 đang hoạt động |
| Số lượt chuyển đổi | Không có | phiên bản thử nghiệm v1 | Phiên bản beta v1 đang hoạt động |
| Thông báo | Không có | phiên bản thử nghiệm v1 | Phiên bản beta v1 đang hoạt động |
| Bài đánh giá | Không có | phiên bản thử nghiệm v1 | Phiên bản beta v1 đang hoạt động |
| Chế độ cài đặt thông tin vận chuyển | Không có | phiên bản thử nghiệm v1 | Phiên bản beta v1 đang hoạt động |
| Product Studio | v1 alpha | Không có | Phiên bản alpha v1 đang hoạt động |
Các phương pháp hay nhất
- Thường xuyên kiểm tra ghi chú phát hành và thông tin cập nhật mới nhất để biết các phiên bản mới, bản cập nhật lớn, điểm cải tiến và thông báo về việc ra mắt và ngừng sử dụng API phụ.
- Nếu một API phụ có 2 phiên bản ổn định trở lên, bạn nên sử dụng phiên bản mới nhất mọi lúc.
- Thiết kế ứng dụng của bạn để xử lý linh hoạt nhiều lỗi API phụ, bao gồm cả các vấn đề về mạng, giới hạn tốc độ và mã hoặc thông báo lỗi mới có thể được đưa vào các phiên bản API phụ mới hơn.
- Đừng đợi đến khi phiên bản API phụ sắp ngừng hoạt động thì mới bắt đầu lên kế hoạch nâng cấp. Bắt đầu đánh giá và thử nghiệm các phiên bản mới ngay khi có.
- Nếu bạn có yêu cầu về tính năng hoặc mối lo ngại về lộ trình của API phụ, hãy liên hệ với chúng tôi để đặt câu hỏi hoặc gửi ý kiến phản hồi. Để biết thông tin về cách liên hệ với nhóm Merchant API để được hỗ trợ kỹ thuật, hãy xem bài viết Yêu cầu trợ giúp về Merchant API.