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

Hướng dẫn tích hợp API Video Shopee

1. Giới thiệu về Shopee Video​

Shopee Video là công cụ tạo nội dung và marketing cho phép người bán và affiliate giới thiệu sản phẩm qua các video ngắn hấp dẫn. Công cụ này mang lại sự linh hoạt cho cả người bán và affiliate trong việc sản xuất và chia sẻ nội dung. Bằng cách tận dụng hình thức kể chuyện trực quan, người sáng tạo có thể tăng mức độ tương tác và thúc đẩy tỷ lệ chuyển đổi cao hơn.

Lợi ích:

  • Thu hút người mua và người theo dõi: Gây chú ý và xây dựng cơ sở khách hàng trung thành.
  • Tăng nhận thức: Giới thiệu sản phẩm và thương hiệu một cách năng động.
  • Thúc đẩy doanh số: Xây dựng niềm tin, cải thiện chuyển đổi và khuyến khích mua hàng.

Open Platform cung cấp một bộ Open API để quản lý video và phân tích, cho phép nhà phát triển tải lên và quản lý video, xuất bản nội dung và theo dõi hiệu suất để tối ưu hóa chiến lược marketing dựa trên video.

2. Tổng quan tích hợp​

Tích hợp với API Shopee Video gồm hai giai đoạn chính:

  • Tải lên video qua API Tải lên Video công khai – Tải lên tệp video và nhận video_upload_id.
  • Quản lý và Xuất bản Video qua API Shopee Video – Dùng các API v2.video.* để chọn ảnh bìa, chỉnh sửa thông tin video, xuất bản, xóa, truy vấn và phân tích hiệu suất video.

3. API Tải lên Video công khai​

Open Platform cung cấp một bộ API tải lên video công khai và cơ chế push, được thiết kế cho tất cả các tình huống tải lên video trong tương lai. Hiện tại, các API này chỉ được hỗ trợ cho Shopee Video.

Danh sách API và Push:

Quy trình tải lên:

  1. Gọi v2.media.init_video_upload để khởi tạo tác vụ tải lên.
  2. Tải lên các phần video qua v2.media.upload_video_part.
  3. Gọi v2.media.complete_video_upload để hoàn tất tải lên.
  4. Hệ thống xử lý video bất đồng bộ và push trạng thái cuối cùng qua video_upload_result_push.
  5. Tùy chọn, gọi v2.media.get_video_upload_result để kiểm tra tiến trình.
  6. Sau khi tải lên thành công, lấy video_upload_id để gọi API Shopee Video.

Lưu ý:

  • Sử dụng cơ chế push để nhận thông báo hoàn tất tải lên bất đồng bộ, tránh polling.
  • Mỗi tác vụ tải lên tương ứng với một video duy nhất; tránh tải lên cùng một video nhiều lần.

4. API Shopee Video​

API Shopee Video được chia thành hai module: Quản lý Video và Phân tích Hiệu suất.

4.1 Quản lý Video​

  1. v2.video.get_cover_list: Lấy ảnh chụp màn hình theo từng khung của video đã tải lên và chọn một khung cụ thể làm ảnh bìa video.

  2. v2.video.edit_video_info: Đặt hoặc chỉnh sửa thông tin video trước khi đăng, bao gồm chú thích video, ảnh bìa, sản phẩm được liên kết, thời gian đăng và có cho phép stitch và duet hay không.

Lưu ý: Video ở trạng thái nháp có thể chỉnh sửa nhiều lần; sau khi xuất bản không thể chỉnh sửa.

  1. v2.video.post_video: Xuất bản video nháp lên Shopee Video. Phải tải lên video và chỉnh sửa thông tin trước.

  2. v2.video.get_video_list: Lấy danh sách video của tài khoản.

  3. v2.video.get_video_detail: Lấy thông tin chi tiết của một video.

  4. v2.video.delete_video: Xóa video nháp hoặc đã xuất bản.

4.2 Phân tích Hiệu suất​

Hiệu suất tổng thể của tất cả video:

  1. v2.video.get_overview_performance: Lấy hiệu suất tương tác nội dung và chuyển đổi giao dịch tổng thể cho tất cả video đã đăng.

  2. v2.video.get_metric_trend: Lấy xu hướng tương tác nội dung và chuyển đổi giao dịch cho tất cả video đã đăng theo thời gian.

  3. v2.video.get_user_demographics: Lấy dữ liệu phân bổ khán giả (độ tuổi, giới tính, địa điểm, thời gian hoạt động, sở thích nội dung và sản phẩm) cho tất cả video đã đăng.

  4. v2.video.get_product_performance_list: Lấy dữ liệu hiệu suất cho các sản phẩm được liên kết với video.

Hiệu suất của từng video:

  1. v2.video.get_video_performance_list: Lấy hiệu suất tổng quan của một video cụ thể.

  2. v2.video.get_video_detail_performance: Lấy hiệu suất tương tác nội dung và chuyển đổi giao dịch của một video cụ thể.

  3. v2.video.get_video_detail_metric_trend: Lấy xu hướng tương tác nội dung và chuyển đổi giao dịch của một video cụ thể để phân tích sự thay đổi hiệu suất theo thời gian.

  4. v2.video.get_video_detail_audience_distribution: Lấy dữ liệu phân bổ khán giả (độ tuổi, giới tính, địa điểm, thời gian hoạt động, sở thích nội dung và sản phẩm) của một video cụ thể để phân tích hồ sơ khán giả.

  5. v2.video.get_video_detail_product_performance: Lấy hiệu suất chuyển đổi giao dịch của các sản phẩm được liên kết với một video cụ thể để đánh giá tác động của video đến doanh số và chuyển đổi.

Lưu ý: Tất cả dữ liệu hiệu suất thường có độ trễ ít nhất một ngày.

5. Ủy quyền & Xác thực (API loại User)​

API Shopee Video là các API loại User, yêu cầu user_id và access_token. Logic ủy quyền và xác thực giống với API Livestream với các điểm sau:

  • Ủy quyền theo vai trò

  • Nếu vai trò được ủy quyền là Người bán, hãy đặt auth_type=seller khi tạo liên kết ủy quyền. Sau khi ủy quyền thành công, gọi v2.public.get_access_token sẽ trả về cả shop_id và user_id.

  • Nếu vai trò được ủy quyền là Affiliate, hãy đặt auth_type=user khi tạo liên kết ủy quyền. Sau khi ủy quyền thành công, gọi v2.public.get_access_token chỉ trả về user_id.

  • Tham số yêu cầu chung: user_id

  • Tất cả lệnh gọi API Shopee Video phải dùng user_id làm tham số yêu cầu chung thay vì shop_id.

  • Chữ ký API (sign) cũng phải được tạo dựa trên user_id.

  • Quản lý Access Token & Refresh Token

  • Token phải được quản lý riêng cho từng user_id.

Để biết luồng ủy quyền và xác thực chi tiết, tham khảo Hướng dẫn tích hợp API Livestream.

6. Lưu ý tích hợp cho nhà phát triển​

  • Chỉ các ứng dụng Quản lý Shopee Video mới có thể truy cập Video OpenAPI. Hãy tạo loại ứng dụng tương ứng trong console trước khi tích hợp.
  • Phải đồng ý với Điều khoản & Điều kiện của Shopee Video trong Seller Center trước khi thực hiện bất kỳ thao tác API liên quan đến Video nào.