Shopee OpenAPI Handsup 👋

Working as a data engineer at Shopee Express, I was assigned to retrieve a specific shop’s data via Shopee Open Platform (Challenge Accepted 👊)

The Shopee Open Platform is a technical services portal with API offerings, supporting developers in creating Partner Apps that grow sellers’ businesses.

Open Platform has a detailed document here. However, I’ve been struggle with its first-time authentication 🤧 Hence, this article will guide you through:

• Authenticate a shop
• Retrieve token
• Get order list

Let’s Gogogogo 🚀🚀🚀

Authenticate a Shop

Image from OpenAPI

Here are steps required to use OpenAPI. By following this guide, we can get an App on Open Platform.

You have a shop, right? We will use the app’s partner id and key, plus the shop’s account and password later.

Auth Flow

With the code above, we create an Auth link. Click the link and log in with the shop’s account and password 🗝

https://partner.shopeemobile.com/api/v2/shop/auth_partner?partner_id=2xxxxx3&redirect=https://www.google.com/&timestamp=1653985317&sign=979xxxx63aaa4

⚠ If you encounter error showing Invalid timestamp, it may be caused from:

• We forget to turn timestamp to type Int
• The link is only valid for 5 minutes. After 5 mins, we need to recreate an auth link with a new timestamp.

⚠ If you face error showing wrong sign, please check whether:

• Environment for key, partner_id, and host match (uat, test, or live)
• Timestamp used to create the sign is identical to the one shown in the url.

If things go well, you will be redirect to the magic link (See the code and shop_id? Awesome, that’s what we want 💛)

https://www.google.com/?code=4e424xxxxxx&shop_id=5xxxxxx9

Retrieve token

With the code, we can get token in this way:

access_token will only be valid for 4 hours. We can get a new one using refresh_token afterwards 😉

Get order list

Hooooray 🎊 With our access_token, we are able to retrieve and update the shop’s orders using OpenAPI.

Cool, isn’t it? You can explore other APIs in its document. Authentication might be the hardest part. As soon as you get the token, the rest is merely a piece of 🍰 Happy Coding :D