[Important Update] IP Address Whitelist Function

Dear Developers,

To enhance Data Security for Shopee’s users, Shopee Open Platform will launch an IP Address Whitelist Function.

What is the IP address whitelist function?

The IP Whitelist Function is a security feature that allows us to control and limit access to Shopee Open API based on predefined, trusted IP address(es). Once enabled, only IP address(es) that have been whitelisted will be able to access Shopee Open API.

How to set up an IP address whitelist?

Please go to the Open Platform Console> App List> App Details>IP Address WhitelistClick “Edit”, check APP IP Address Management and then enable the IP address whitelist

Please ensure that your IP address(es) are correct and fill in all of your remaining IP address(es) that you wish to connect to this APP. Repeat the same action for all of your other APP(s).

Do note that once the “Enable IP Address Whitelist” toggle is enabled, only declared IP addresses can make API calls. If an undeclared source IP address makes an API call, an error message will be displayed as follows:

“Request Source IP (xx.xx.x.xx) is undeclared. Please declare all your IP addresses in the Open Platform Console > App list > IP Address Whitelist“.

Action Required

You are required to complete IP whitelist declaration and enable function by 27 December 2023 23:59 (GMT+8).

Subsequently, All buyer-sensitive data will be masked when using the following API calls: 'v2.order.get_order_detail,' 'v2.returns.get_return_list,' 'v2.returns.get_return_detail,' and 'v2.order.get_buyer_invoice_info'.

With this enhancement, it will help Shopee enhance our data security measures, and ensure a safe marketplace for all Shopee users. If you have any questions, please check the FAQ or raise a ticket to our support team.

Effective Date: Lived

Open Platform Team

尊敬的开发者：

为了增强Shopee用户的数据安全性，Shopee开放平台将推出 IP 白名单功能。

什么是 IP 地址白名单功能？

IP 地址白名单功能，它允许我们基于申报的受信任 IP 地址来控制对Shopee开放API的访问。一旦启用，只有在白名单上的IP地址才能访问Shopee OpenAPI。

如何设置IP地址白名单？

请前往开放平台控制台>App List> App Details page> IP Address Whitelist点击“Edit”，将所有IP地址填写在“App IP Address Management”，然后点击开关启用IP地址白名单。请确保您的IP地址是正确的，并填写您希望连接到此应用程序的所有IP地址。对于您的其他应用程序，请重复相同的操作。

请注意，一旦启用“启用IP地址白名单”开关，只有声明的IP地址才能进行API调用。如果未声明的源IP地址进行API调用，将显示以下错误消息：

“Request Source IP (xx.xx.x.xx) is undeclared. Please declare all your IP addresses in the Open Platform Console > App list > IP Address Whitelist”

需要采取的措施

您需要在2023年12月27日23:59（GMT+8）之前完成IP地址白名单的申报并启用该功能。

如果在27号前未开启IP 白名单，在以下API调用中使用时，所有与买家相关的敏感数据将被屏蔽：“v2.order.get_order_detail”，“v2.returns.get_return_list”，“v2.returns.get_return_detail”，和“v2.order.get_buyer_invoice_info”。

通过这项功能，将有助于Shopee提高我们的数据安全措施，确保为所有Shopee用户提供一个安全的市场。如果您有任何问题，请查看FAQ或向我们的支持团队提出工单。

上线时间：已上线

开放平台团队