Significant OpenAPI Updates for Livestream Management

Dear Developers,

Shopee has officially launched Livestream Management Open APIs, covering livestream session management, product management, comment interaction, and real-time data retrieval. These APIs empower developers to build livestream management systems for streamers, enhancing streaming efficiency and user experience.

1. Scope of Availability

- Supported Sites: Currently, Livestream OpenAPI is only available for Taiwan (TW), Indonesia (ID), and Thailand (TH).

- Supported Roles: Supports two types of roles — Seller Streamers and Affiliate Streamers.

- Application Type: Only Livestream Management applications are eligible to access the Livestream OpenAPI. Please create a Livestream Management type of application in the Console before integration.

2. Authorization & Authentication

The authorization process for Livestream APIs is similar to the existing Shop Authorization process, but with the following differences:

1. Role-based Authorization

- If the authorized role is Seller Streamer, set auth_type=seller when generating the authorization link. After successful authorization, calling v2.public.get_access_token will return both shop_id and user_id.

- If the authorized role is Affiliate Streamer, set auth_type=user. After successful authorization, calling v2.public.get_access_token will only return user_id.

2. Common Request Parameter: user_id

- All livestream-related API calls use user_id as the common request parameter instead of shop_id.

- API signature (sign) must also be generated based on user_id.

3. Access Token & Refresh Token Management

- access_token and refresh_token usage is consistent with existing APIs, but tokens must be managed separately for each user_id.

For more details, please refer to the Livestream API Integration Guide.

3. Livestream API Capabilities

The current Livestream API suite supports the following operations:

For more details, please refer to the Livestream API Integration Guide.

尊敬的开发者，

Shopee现已上线直播管理相关Open API，包括直播间管理、直播商品管理、评论互动及直播数据获取等，支开发者为主播构建直播管理系统，提升直播效率与用户体验。

1. 适用范围

- 适用站点：目前直播Open API仅开放 台湾 (TW)、印尼 (ID)、泰国 (TH) 三个站点。

- 授权对象：支持 卖家主播、Affiliate主播 两种角色。

- 应用类型：仅限 Livestream Management 类型的应用，具有调用直播Open API的权限，请先在Console创建 Livestream Management 类型的应用。

2. 授权与鉴权

直播相关接口的授权流程，与当前的店铺授权流程类似，但是存在以下区别：

1）授权角色区分

- 若授权对象为卖家主播，生成授权链接时需设置auth_type=seller，授权成功后通过v2.public.get_access_token获取access_token时，返回shop_id + user_id；

- 若授权对象为Affiliate主播，生成授权链接时需设置auth_type=user，授权成功后通过v2.public.get_access_token获取access_token时，仅返回user_id。

2）接口公共参数为user_id

- 所有直播相关接口调用均以user_id作为公共请求参数，而非shop_id；

- 所有直播相关接口的签名需基于user_id构造。

3）access_token与refresh_token管理

- access_token与refresh_token的使用方式一致，但需为每个 user_id 管理独立的 access_token 与 refresh_token。

详细内容请参考：直播管理对接指引。

3. 直播接口能力

目前已开放的直播相关接口能力涵盖如下操作：

详细内容参考：直播管理对接指引。