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

Thẻ thực thể API

Trong TikTok Shop API Reference, mỗi endpoint được nhóm dưới một thẻ thực thể (entity tag). Các thẻ này giúp nhà phát triển nhanh chóng hiểu được:

  • Loại thực thể mà API thao tác (ví dụ: seller, shop, partner, creator, asset) và phạm vi truy cập của nó
  • Loại ủy quyền cần thiết (ví dụ: shop token, seller token)

Cách tổ chức này cung cấp cho nhà phát triển ngữ cảnh rõ ràng về phạm vi của từng endpoint và cách sử dụng nó chính xác trong quá trình tích hợp.

Image

Ví dụ về một thẻ thực thể API

Các loại thẻ thực thể

Thẻ Seller​

Các endpoint có thẻ Seller thao tác ở cấp tài khoản seller. Cần có seller access token để truy cập dữ liệu của seller.

Các endpoint này chủ yếu được dùng để quản lý dữ liệu cấp seller hỗ trợ các thao tác liên shop. Bao gồm metadata phạm vi toàn seller (ví dụ: lấy danh sách các shop thuộc sở hữu của seller), các asset có thể tái sử dụng (ví dụ: tải lên hình ảnh không gắn với shop cụ thể), và dữ liệu sản phẩm toàn cục dùng để nhân bản danh sách sản phẩm local trên nhiều shop (ví dụ: tạo global product).

Chúng không thể được dùng để truy cập hoặc quản lý dữ liệu của từng local shop riêng lẻ như local product hoặc đơn hàng của một shop.

Thẻ Shop​

Các endpoint có thẻ Shop thao tác ở cấp local shop. Cần có seller access token và một shop cipher để truy cập dữ liệu của shop. Mỗi shop có shop cipher riêng, và dữ liệu được cô lập khỏi các shop khác.

Các endpoint này chủ yếu được dùng để quản lý dữ liệu trong một shop, chẳng hạn như đăng một sản phẩm trong shop, lấy đơn hàng của shop, v.v.

Chúng không thể được dùng để truy cập hoặc quản lý dữ liệu trải rộng trên nhiều shop thuộc cùng một tài khoản seller.

Thẻ Account​

Các endpoint có thẻ Account thao tác ở cấp tài khoản partner. Cần có partner access token để truy cập dữ liệu của partner.

Các endpoint này chủ yếu được dùng để quản lý dữ liệu liên quan đến tài khoản partner, chẳng hạn như lấy danh sách business category asset mà một partner đã ủy quyền cho một app.

Chúng không thể được dùng để truy cập hoặc quản lý trực tiếp các campaign asset của partner.

Thẻ Creator​

Các endpoint có thẻ Creator thao tác ở cấp tài khoản creator. Cần có creator access token để truy cập dữ liệu của creator.

Các endpoint này chủ yếu được dùng để quản lý dữ liệu liên quan đến một creator, chẳng hạn như lấy profile của creator, lấy các đơn hàng affiliate do creator tạo ra, tìm kiếm các mục hợp tác mở (open collaboration), v.v.

Thẻ Asset​

Các endpoint có thẻ Asset thao tác ở cấp campaign asset của partner. Cần có partner access token và category asset cipher liên quan để truy cập dữ liệu campaign của partner.

Các endpoint này chủ yếu được dùng để quản lý các chiến dịch affiliate marketing và xử lý các sản phẩm trong chiến dịch.