来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 SPI Service Enables Independent Partner Key
Dear Developer,
Please note the following updates:
§2 1. Background
1. Background
SPI (Service Provider Interface) is Shopee’s service interface framework used between Shopee and specific partners. It is mainly used for Shopee-initiated data callbacks and system-to-system interactions.
The following App Types currently support SPI services:
- Brand Membership
- Seller Logistics
- Swarm ERP
Previously, SPI services shared the same Partner Key with Open APIs. Since Open API Partner Keys expire every 180 days, developers must reset them periodically to ensure continued API access. During Open API Partner Key reset periods, SPI callback requests may be rejected due to signature verification failures, which can temporarily disrupt data synchronization.
To prevent this issue, the platform now provides independent Partner Key for SPI services. This key is not affected by Open API Partner Key resets, and developers can reset the SPI Partner Key proactively to ensure the security and stability of your services.
§3 2. Update Details
2. Update Details
§4 2.1 Introduce New Live SPI Partner Key
2.1 Introduce New Live SPI Partner Key
For the above App Types, a new Live SPI Partner Key has been added in: Console > App Management > App List > App Detail page, for SPI signature verification.
Notes:
- For existing apps of these App Types, the system will automatically generate a Live SPI Partner Key. Its initial value will be the same as the original Open API Partner Key.
- Resetting the Live API Partner Key or Live Push Partner Key will not affect the Live SPI Partner Key. After this change, developers need to maintain three separate Partner Keys in the system for Open API, Push Mechanism, and SPI.
§5 2.2 Live SPI Partner Key Reset Guide
2.2 Live SPI Partner Key Reset Guide
The platform will not automatically reset the Live SPI Partner Key. You can reset it manually if needed:
- Go to Console > App Management > App List > App Detail, click Edit to open the App Edit page.
- Click the Reset button next to Live SPI Partner Key and select an Effective Time to complete the reset.
Notes:
- After the Effective Time, all new SPI calls will use the new Partner Key for signature generation.
- To prevent SPI service disruption, your system must support both old and new Partner Keys for at least 1 day after the effective time, ensuring successful signature verification during the transition.
§6 3. Impact to Developers
3. Impact to Developers
- Resetting Open API Partner Key, SPI Partner Key, and Push Partner Key are independent operations and do not affect each other.
- Developers can proactively reset the Live SPI Partner Key based on your own security requirements.
- Developers must ensure that your systems can validate signatures from both old and new Live SPI Partner Keys for at least 1 day after the new key takes effect to avoid interrupting Shopee SPI callbacks.
Effective Date:
2026.02.11
亲爱的开发者:
请注意以下更新:
§7 1. 背景
1. 背景
SPI (Service Provider Interface) 服务是 Shopee 与特定合作伙伴之间使用的服务接口体系,主要用于 Shopee 主动回调数据及系统间交互。
目前支持 SPI 服务的 App Type包括:
- Brand Membership
- Seller Logistics
- Swarm ERP
此前,SPI 服务与 Open API 共用同一套 Partner Key。由于 Open API Partner Key 有效期为 180 天,开发者需定期进行重置,以确保 Open API 调用持续有效。在 Open API Partner Key 重置期间,SPI 回调请求可能因签名校验失败而被拒绝,进而导致数据同步短暂中断。
为避免上述问题,本次升级为 SPI 服务提供独立的 Partner Key,使其不再受 Open API Partner Key 重置影响,同时支持开发者自主重置 SPI Partner Key,确保自身服务安全性。
§8 2. 更新内容
2. 更新内容
§9 1) 新增 Live SPI Partner Key
1) 新增 Live SPI Partner Key
针对上述 App Type,在 Console > App Management > App List > App Detail 页面,新增独立的 Live SPI Partner Key,用于 SPI 服务签名校验。
注意:
- 对于历史已创建的上述 App Type 应用,系统将自动生成 Live SPI Partner Key,且初始值与与原本 Open API Partner Key 相同。 - 重置 Live API Partner Key 或 Live Push Partner Key 时,Live SPI Partner Key 将不会受到影响 (即:不会随之被重置)。此后,您需要在系统里为 Open API、Push Mechanism、SPI 分别维护三套 Partner Key。
§10 2) Live SPI Partner Key 重置指引
2) Live SPI Partner Key 重置指引
平台不会主动重置 Live SPI Partner Key。如您有安全需要,平台支持自行重置:
针对上述 App Type,在 Console > App Management > App List > App Detail 页面点击 “Edit” 按钮,进入 App 编辑界面,点击 “Live SPI Partner Key” 右侧的 “Reset” 按钮,并选择 “Effective Time”,即可完成重置。
注意:
- Effective Time 后新发起的 SPI 调用,平台将会使用新的 Partner Key 生成 Sign,因此,重置 Live SPI Partner Key 后,为避免 SPI 服务中断,您的系统需要确保在生效时间后 1 天内,同时兼容新旧 Partner Key 签名校验。
§11 3. 对开发者影响
3. 对开发者影响
- API Partner Key / SPI Partner Key / Push Partner Key 三者的重置操作互不影响。
- 开发者可根据自身安全需求主动重置 Live SPI Partner Key。
- 开发者需保证在新的 Live SPI Partner Key 生效后 1 天内,兼容新旧 Live SPI Partner Key 同时鉴权,以确保 Shopee SPI 回调不中断。
生效日期:
2026.02.11
