Chuyển tới nội dung chính

Phiên bản API (API versioning)

Việc quản lý phiên bản API cho phép TikTok Shop liên tục cải tiến và mở rộng các khả năng của API, đồng thời duy trì trải nghiệm liền mạch cho người dùng khi API phát triển.

Khi các thay đổi phá vỡ (breaking changes) được áp dụng cho các API của TikTok Shop, những thay đổi này sẽ được triển khai thông qua các phiên bản API mới. Các thay đổi phá vỡ trong API thường xảy ra nhằm cải thiện chức năng tổng thể, bổ sung khả năng mới hoặc tăng cường các biện pháp bảo mật. Những thay đổi này là cần thiết để bắt kịp các công nghệ đang phát triển và nhu cầu của người dùng. Để đảm bảo tích hợp liền mạch và tận dụng những cải tiến này, việc luôn cập nhật lên các phiên bản API mới nhất là rất quan trọng.

Ví dụ về các thay đổi không phá vỡ và các thay đổi phá vỡ:

Lịch phát hành API và cách đặt tên phiên bản

Hiện tại, các phiên bản API mới được triển khai theo chu kỳ hàng tháng. Không phải tất cả các API đều được cập nhật mỗi tháng.

Cách đặt tên phiên bản API (ví dụ: 202303) được lấy từ năm và tháng ra mắt của phiên bản đó.

Chọn phiên bản API trong tài liệu tham chiếu API

Phiên bản API được gán ở cấp độ từng API, nghĩa là các API khác nhau có thể có các phiên bản khác nhau. Ví dụ, phiên bản mới nhất của Create Product API là 202212 (phát hành vào tháng 12, 2022), trong khi phiên bản mới nhất của Get Order Details API có thể được đặt tên là 202312.

Trang tài liệu tham chiếu API hiển thị phiên bản mới nhất của API theo mặc định. Trên trang này, bạn có tùy chọn chọn từ menu thả xuống để xem các phiên bản được hỗ trợ khác. Bằng cách nhấp vào tên một phiên bản trong menu thả xuống, bạn có thể truy cập tài liệu tham chiếu cho phiên bản API cụ thể đó.

Các API khác nhau từ các phiên bản khác nhau nhìn chung có thể được kết hợp và sử dụng cùng nhau, nhưng cần được kiểm thử kỹ lưỡng. Trong phần lớn các trường hợp, chúng tôi khuyến nghị sử dụng phiên bản API mới nhất hiện có, và nếu có thể, hãy sử dụng cùng một phiên bản.

Chỉ định phiên bản API khi gọi một API

Sau phiên bản 202309, bạn cần truyền version trong path để yêu cầu đúng phiên bản của API. Ví dụ,

HTTPWord Wrap

https://open-api.tiktokglobalshop.com/product/202309/products/1729435271479265816

Nâng cấp lên phiên bản API mới

Trước khi nâng cấp lên phiên bản API mới, chúng tôi khuyến nghị bạn đọc changelog và tài liệu tham chiếu API của phiên bản API mới để tìm hiểu những thay đổi nào được bao gồm và cách tích hợp phiên bản API mới. Chọn menu thả xuống và nhấp vào tên một phiên bản để xem tài liệu tham chiếu API cho phiên bản đó.

Ngừng hỗ trợ một phiên bản của API

Sau khi một phiên bản API mới được phát hành, phiên bản trước đó sẽ vẫn khả dụng trong tối thiểu 2 tháng.

Khi một API được lên lịch ngừng hỗ trợ, thông báo sẽ được truyền đạt qua changelog của chúng tôi ít nhất 2 tháng trước khi nó ngừng hoạt động vĩnh viễn.

Nếu bạn sử dụng một phiên bản đã ngừng hỗ trợ hoặc không hợp lệ, API sẽ trả về lỗi trong phản hồi cho biết phiên bản API đó không được hỗ trợ.

THRIFTWord Wrap

{  
    "code":36009014,  
    "data":null,  
    "message":"The version name is invalid, please check and retry."  
}

Luôn cập nhật

Changelog​

Changelog là nguồn thông tin chính để bạn nắm bắt mọi thay đổi của API, cả những thay đổi lớn và nhỏ. Việc thường xuyên kiểm tra Changelog đảm bảo bạn luôn cập nhật những thay đổi mới nhất, cho phép bạn chủ động phản ứng với các thay đổi và mang lại trải nghiệm app vượt trội cho người dùng của mình.