快工助手跨境电商知识与商机助手

[Important] Livestream OpenAPI Now Available in PH/MY/SG/VN

Shopee 官方资料 · Shopee Open Platform 变更通知(Announcements) · 适合开发者

stable本次发布有变化全部展示

来自 Shopee 官方资料快照 ·

打开官方原文 ↗
  1. 当前资料结构化阅读页
  2. 固定快照已留存,可追溯
  3. 官方原文可核对
查看技术与溯源信息
平台 / profile
Shopee / profile.shopee.announcements
语言
en
发布版本
cn-20260909-2
标签
zhuge/sourceplatform/shopeeaudience/developercategory/announcementtopic/apitopic/api-livestreamtopic/changelogtopic/developertopic/openapi-updates

资料正文

§1 [Important] Livestream OpenAPI Now Available in PH/MY/SG/VN

Dear Developers,

We are pleased to announce that Shopee Livestream OpenAPI has been expanded to additional regions, including Philippines (PH), Malaysia (MY), Singapore (SG), and Vietnam (VN).

The Livestream OpenAPI provides a comprehensive set of capabilities covering livestream session management, product management, comment interaction, and real-time data retrieval. These APIs enable developers to build livestream management systems for streamers, improving operational efficiency and user experience.

#

§2 1. Scope of Availability

1. Scope of Availability

  1. Supported Sites

Livestream OpenAPI is now available in the following regions:

- Newly added: Philippines (PH), Malaysia (MY), Singapore (SG), Vietnam (VN)

- Existing: Taiwan (TW), Indonesia (ID), Thailand (TH).

  1. Supported Roles

The following streamer roles are supported:

- Seller Streamer

- Affiliate Streamer

  1. Application Type

Only applications of type Livestream Management are eligible to access the Livestream OpenAPI.

Please create a Livestream Management application in the Console before integration.

#

§3 2. Authorization & Authentication

2. Authorization & Authentication

The authorization flow of 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.

  1. 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.

  1. Access Token & Refresh Token Management

- The usage of access_token and refresh_token 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.

#

§4 3. Livestream API Capabilities

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 Livestream OpenAPI 已扩展至更多地区,包括菲律宾 (PH)、马来西亚 (MY)、新加坡 (SG) 和越南 (VN)。

Livestream Open API 提供了全面的功能,包括直播间管理、直播商品管理、评论互动及直播数据获取等, 开发者可以利用这些 API 构建专业的直播管理系统,提升主播的运营效率和用户体验。

#

§5 1. 适用范围

1. 适用范围

1)适用站点

Livestream OpenAPI 现已在以下地区可用:

- 新增地区:菲律宾 (PH)、马来西亚 (MY)、新加坡 (SG)、越南 (VN)

- 已支持地区:台湾 (TW)、印度尼西亚 (ID)、泰国 (TH)

2)授权对象

支持以下两类主播角色:

- 卖家主播 (Seller Streamer)

- 达人主播 (Affiliate Streamer)

3)应用类型

仅限 Livestream Management 类型的应用,具有调用 Livestream OpenAPI 的权限,请先在 Console 创建 Livestream Management 类型的应用。

#

§6 2. 授权与鉴权

2. 授权与鉴权

Livestream OpenAPI 的授权流程,与现有的店铺授权流程类似,但是存在以下差异:

1)授权角色区分

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

- 若授权对象为达人主播,生成授权链接时需设置 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 的使用与现有 API 保持一致,但需为每个 user_id 管理独立的 access_token 与 refresh_token。

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

#

§7 3. Livestream API 功能

3. Livestream API 功能

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

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

#