基本说明

串接前评估

若欲查看Open API平台相关介绍和API功能,请查看此说明事项。

或请贵司的工程师参考此平台文件,以评估您预期欲使用的功能是否可透过本API串接达成。

问题排除方法

若您串接时遇到问题,建议可先查找F&Q。

若仍无法解决您的问题,请来信openapi@support.shopee.com或是联系您的客户经理且提供以下信息。

●   对应的问题描述:

●   所使用的对应环境:

●   所使用的对应API接口:

●   所使用的对应request body及所属站点:

●   调用接口之后所得到的对应返回req_id(具体时间)及对应返回的信息(错误代码和错误信息):

 

卖场授权方法

授权说明

为了保护Shopee OpenPlatform免受潜在的漏洞影响并更好地保护开发人员的机密性,OpenAPI 2.0(v2)引入了更新方法来授权商店和验证API请求。

v2方法只能应用于v2 API,而v1方法只能应用于v1 API。可透过呼叫网址判断该API是v1或v2,如下表:

呼叫网址

https://partner.shopeemobile.com/api/v1/item/add

https://partner.shopeemobile.com/api/v2/shop/cancel_auth_partner

 

v1授权网址组成说明

开发人员按照以下规则生成授权链接,连结提供给卖场营运人员进行授权。授权完毕后即可透过API对店铺进行操作。

开发人员应使用Partner ID、Key提供的测试凭据和测试车间信息来模拟此过程。

授权连结组成需包含一个固定的授权URL和必需的参数。取消授权作法流程同卖场授权流程。

授权网址


https://partner.shopeemobile.com/api/v1/shop/auth_partner

正式环境

https://partner.uat.shopeemobile.com/api/v1/shop/auth_partner

测试环境

 

取消授权网址


https://partner.shopeemobile.com/api/v1/shop/cancel_auth_partner

正式环境

https://partner.uat.shopeemobile.com/api/v1/shop/cancel_auth_partner

测试环境

 

授权使用参数


Id

Partner ID可点选右上角console后选择APP,则可在APP   List中查看

Token

请按照要求产生token,参考下方"token组成范例"

redirect

仅在授权成功后导向的页面,可以使用任何网址(e.g.公司网站、卖场网址)

 

v1授权网址组成步骤

Partner key和redirect url为构成组成的重点,组成范例Partner key+redirect url:

 

2.加密字符串

依上一步骤将字符串结合后需要透过SHA256 hashing algorithm(not HMAC)加密,加密后则为Token。加密后范例如下:

815d97b3a582e2e39957545a0c8c3da63d2466b902a32956ddd7a784badccdb8

 

3.组成授权网址

接着按照上述"授权网址组成范例"的规则组成授权网址

https://partner.shopeemobile.com/api/v1/shop/auth_partner?id=70148&token=8e23ec43c9ef372d998 797c029b48545a21b01e876a58b51b02ad1759c8bc4de&redirect=https%3A%2F%2Fwww.baidu.c om

 

v1授权逾时逻辑

透过任何浏览器进入卖场授权网址(如上述"授权网址组成范例")后,您将会被重新导向,重新导向的网址为随机数生成,而随机数生成后的网址需要在3分钟内完成卖场授权或取消卖场授权,若未在3分钟内完成将会得到错误讯息"operation overtime",需要重新进入卖场授权网址,无法直接重新整理使用随机数生成后的网址登入。

 

v1验证请求说明

此为呼叫API时须使用的加密授权验证。

以下教学同Shopee Open Platform - Authenticating a Request

这一部分将说明如何创建HMAC-SHA256加密签名,针对HTTP请求。

请求方式为POST,以下范例使用API::https://partner.shopeemobile.com/api/v1/orders/detail

 

Step1.建立签名基本字符串

API URL | Request

基本字符串产生规则如下:

 

Step2.通讯协议

当呼叫API及产生加密签名时,使用正确的通讯协议非常重要! 请确保使用的通讯协议为https://或http://。

 

Step3.HTTP呼叫内容

当呼叫时,您的HTTP呼叫格式该使用raw,HTTP header使用 Content-Type: application/json Request范例如下:

 

Step4.准备金钥

密钥为呼叫API的重要关键,请勿随意对外透漏您的密钥。

 

Step5.签名加密

最后,通过将第1步产生的基本字符串和密钥传递给HMAC-SHA256 hashing algorithm加密签名后即可使用在呼叫API时使用。

shopee官网原文详情:

基本說明

串接前評估

若欲查看Open API平臺相關介紹和API功能,請查看此說明事項。

或請貴司的工程師參考此平臺檔,以評估您預期欲使用的功能是否可透過本API串接達成。

問題排除方法

若您串接時遇到問題,建議可先查找F&Q。

若仍無法解決您的問題,請來信openapi@support.shopee.com或是聯繫您的客戶經理且提供以下資訊。

●   對應的問題描述:

●   所使用的對應環境:

●   所使用的對應API介面:

●   所使用的對應request body及所屬網站:

●   調用介面之後所得到的對應返回req_id(具體時間)及對應返回的資訊(錯誤代碼和錯誤資訊):

 

賣場授權方法

授權說明

為了保護Shopee OpenPlatform免受潛在的漏洞影響並更好地保護開發人員的機密性,OpenAPI 2.0(v2)引入了更新方法來授權商店和驗證API請求。

v2方法只能應用於v2 API,而v1方法只能應用於v1 API。可透過呼叫網址判斷該API是v1或v2,如下表:

呼叫網址

https://partner.shopeemobile.com/api/v1/item/add

https://partner.shopeemobile.com/api/v2/shop/cancel_auth_partner

 

v1授權網址組成說明

開發人員按照以下規則生成授權連結,連結提供給賣場營運人員進行授權。授權完畢後即可透過API對店鋪進行操作。

開發人員應使用Partner ID、Key提供的測試憑據和測試車間資訊來類比此過程。

授權連結組成需包含一個固定的授權URL和必需的參數。取消授權作法流程同賣場授權流程。

授權網址


https://partner.shopeemobile.com/api/v1/shop/auth_partner

正式環境

https://partner.uat.shopeemobile.com/api/v1/shop/auth_partner

測試環境

 

取消授權網址


https://partner.shopeemobile.com/api/v1/shop/cancel_auth_partner

正式環境

https://partner.uat.shopeemobile.com/api/v1/shop/cancel_auth_partner

測試環境

 

授權使用參數


Id

Partner   ID可點選右上角console後選擇APP,則可在APP   List中查看

Token

請按照要求產生token,參考下方"token組成範例"

redirect

僅在授權成功後導向的頁面,可以使用任何網址(e.g.公司網站、賣場網址)

 

v1授權網址組成步驟

Partner key和redirect url為構成組成的重點,組成範例Partner key+redirect url:

 

2.加密字串

依上一步驟將字串結合後需要透過SHA256 hashing algorithm(not HMAC)加密,加密後則為Token。加密後範例如下:

815d97b3a582e2e39957545a0c8c3da63d2466b902a32956ddd7a784badccdb8

 

3.組成授權網址

接著按照上述"授權網址組成範例"的規則組成授權網址

https://partner.shopeemobile.com/api/v1/shop/auth_partner?id=70148&token=8e23ec43c9ef372d998 797c029b48545a21b01e876a58b51b02ad1759c8bc4de&redirect=https%3A%2F%2Fwww.baidu.c om

 

v1授權逾時邏輯

透過任何流覽器進入賣場授權網址(如上述"授權網址組成範例")後,您將會被重新導向,重新導向的網址為亂數產生,而亂數產生後的網址需要在3分鐘內完成賣場授權或取消賣場授權,若未在3分鐘內完成將會得到錯誤訊息"operation overtime",需要重新進入賣場授權網址,無法直接重新整理使用亂數產生後的網址登入。

 

v1驗證請求說明

此為呼叫API時須使用的加密授權驗證。

以下教學同Shopee Open Platform - Authenticating a Request

這一部分將說明如何創建HMAC-SHA256加密簽名,針對HTTP請求。

請求方式為POST,以下範例使用API::https://partner.shopeemobile.com/api/v1/orders/detail

 

Step1.建立簽名基底字元串

API URL | Request

基底字元串產生規則如下:

 

Step2.通訊協定

當呼叫API及產生加密簽名時,使用正確的通訊協定非常重要! 請確保使用的通訊協定為https://或http://。

 

Step3.HTTP呼叫內容

當呼叫時,您的HTTP呼叫格式該使用raw,HTTP header使用 Content-Type: application/json Request範例如下:

 

Step4.準備金鑰

金鑰為呼叫API的重要關鍵,請勿隨意對外透漏您的金鑰。

 

Step5.簽名加密

最後,通過將第1步產生的基底字元串和金鑰傳遞給HMAC-SHA256 hashing algorithm加密簽名後即可使用在呼叫API時使用。

文章来源:shopee官方网站