[Important] Open API 1.0 Deprecation Plan

Dear Developers

In use since 18 May 2021, Open API 2.0 has proven to be safer with better functionalities than Open API 1.0.

As such, Shopee will gradually deprecate Open API 1.0 by the end of 2022, only Open API 2.0 will be supported and developers are strongly encouraged to migrate and utilize the new version. The deprecation plan will happen across 3 phases, with each lasting for 90 days.

Shopee will provide you with the necessary support. If you have any questions, please raise a ticket in our Ticket System.

Action required

1. Complete the acknowledgment survey by 11 June 2022, or your APP(s) will no longer be able to access below Open API 1.0 from 12 June 2022 onwards.

2. Review attached list of Phase 1 APIs and complete migration by 23:59 (GMT+8) 10 August 2022. These APIs will be deprecated on 11 August 2022.

FAQs

1. Do I need to integrate Open API 2.0 Authorization with my APP(s) before migrating my APIs?

Yes, integration of Open API 2.0 Authorization with my APP(s) is necessary before migrating your APIs. Refer to Open API 2.0 Overview for the new authorization and authentication instructions.

2. Do I need to create a new APP to integrate with Open API 2.0?

No, you do not need to. Also, note that APP(s) created after 28 March 2022 can only call Open API 2.0.

3. How do I transfer existing seller authorizations from Open API 1.0 to Open API 2.0?

Here are 2 methods to transfer existing seller authorizations to Open API 2.0:

Method 1

i) Get the upgrade_code. You may refer to the announcement to learn how.

ii) Call the v2.public.get_refresh_token_by_upgrade_code to get existing shops’ refresh_token from sellers who have granted authorization.

Method 2

Get sellers’ refresh_token and access_token through the usual shop authorization process.

4. Can I still call other APIs not included in the Phase 1 Open API 1.0 deprecation plan list from 11 August 2022?

Yes, you will still be able to do so.

5. If I lose the access_token or the refresh_token after migrating to Open API 2.0, how do I get a new valid token?

Here are 2 methods to get a new valid token:

Method 1

You can call the v2.public.get_token_by_resend_code to get a new valid refresh_token and access_token. Refer to this FAQ on resending code on  the Shopee Open Platform for more information.

Method 2

Get sellers’ refresh_token and access_token through the usual shop authorization process.

6. What happens if I am unable to migrate to Open API 2.0 by 23:59 (GMT+8) 10 August 2022?

If you are unable to do so, from 11 August 2022, your APP functionalities will be affected if they rely on the Open API 1.0 APIs to be deprecated in Phase 1.

Review attached list of Phase 1 APIs.

尊敬的开发者

Shopee于2021年5月18日正式发布OpenAPI 2.0, 相比较1.0其拥有更安全、功能更强大等特点。

因此，Shopee将逐步分批次下线1.0接口，并且预计在2022年底完成所有1.0接口的下线，后续新功能将仅在OpenAPI 2.0支持，还请各位开发者积极对接OpenAPI 2.0。Open API 1.0的下线将会分为3个阶段，每个阶段预计持续90天。

我们将竭诚为您提供服务，如有疑问可通过Ticket System与我们取得联系。

接下来：

1. 开发者需要在2022年6月11日之前完成下线公告的知晓，否则从2022年6月12日起将无法调用以下Open API 1.0接口

2. 查看第一批1.0接口下线列表，并且于2022年8月11日（GMT+8）前完成对应接口的迁移工作，从2022年8月11日起，第一批1.0下线接口将无法调用

FAQ：

1. 在接口切换至OpenAPI 2.0的过程中是否需要先对接 2.0的授权？

– 是的，需要先对接OpenAPI 2.0授权，详情请参考OpenAPI 2.0 Overview授权与鉴权

2. 我是否需要创建新的App对接OpenAPI 2.0？

– 不需要。此外，自2022-03-28后创建的app仅能调用OpenAPI 2.0

3. 如何将存量的授权卖家从1.0的授权迁移到2.0？

– 方法一：拿到 upgrade_code， 并通过upgrade_code调用v2.public.get_refresh_token_by_upgrade_code获取存量店铺的refresh_token

– 方法二：通过OpenAPI 2.0的正常授权流程

4. 将卖家授权迁移至2.0后，是否还可以调用其他不在此次下线范围内的OpenAPI 1.0的接口？

– 可以

5. 将卖家授权迁移至2.0后，在使用的过程中如果token丢失，如何拿到新的可用token？

– 方法一：可以通过调用v2.public.get_token_by_resend_code拿到一组新的refresh_token与access_token，可参考FAQ

– 方法二：通过OpenAPI 2.0的正常流程重新授权

6. 如果我没有按时完成迁移至openAPI 2.0会怎么样？

– 以下接口将会在2022-08-11日下线，届时将不可调用，从而会影响您的系统功能。

附 第一批下线接口列表：

Shopee OpenAPI Team

2022-05-11