API相關工具使用說明


一、API測試工具

 API測試工具,資料環境分為:測試(也稱為沙箱環境)、正式(包括應用正式測試環境、上線運行)。測試工具連結 

//open.taobao.com/apitools/apiTools.htm

1、 在測試環境下使用API​​測試工具須注意3點:

1)測試環境下的數據都是模擬線上的測試數據,不能與線上數據混淆。

2)當存取一個存取等級為「須使用者登入",或須取得存取等級為"隱私資料須使用者登入"的隱私資料時,就需要sessionkey .在測試環境下取得SessionKey,請參閱如何取得sessionkey?

3)可以自訂App Key,用自己申請的App Key和App Secret來測試。

4)如何取得沙箱環境測試帳號?

介面預覽

T1c.9eXdJyXXaCwpjX.png

2、在正式環境下使用API​​測試工具須注意3點:

1)正式環境下的數據都是真實的數據。

2)用系統預設的App Key測試時,透過點擊「綁定使用者」並用商家帳號登入淘寶網來取得SessionKey,SessionKey有效時間為半小時。如果要換商家測試,那麼再次點選「綁定使用者」重新取得SessionKey即可。綁定成功後,點選「提交測試」。

3)用自訂的App Key和App Secret測試時,在正式環境下取得SessionKey,請參閱如何取得sessionkey?

【介面預覽】

T1XEWeXltzXXaCwpjX.png

3、常見問題:

1)參數傳入錯誤。一般是藍色星號的參數沒有傳入。紅色星號的參數為必傳參數。也可能傳入參數格式或類型不對。錯誤排查參考錯誤碼一覽文件快速檢查問題錯誤碼排查工具

2)點選提交測試沒反應。清除快取或換瀏覽器,但少數介面確實需要一定時間才能產生回傳結果,如taobao.trades.sold.get 搜尋目前會話使用者作為賣家已賣出的交易資料。

3)介面呼叫限制只能塔內調用,如何使用測試工具。

在開發者中心後台-聚石塔本地測試增加需要測試的nick,就可以進行塔外IP測試了。

T1samEFA8cXXb1upjX.jpg

 二、API屬性工具 

#API屬性工具,它的主要功能是產生商品屬性(props)、銷售屬性(sku_properties)、自訂類別目屬性(input_pids)和自訂屬性值(input_str)。首先,選擇商品類目,然後填寫屬性表單,最後點選「提交」就產生各種屬性串 了。帶*的為商品的必須屬性,產生的屬性字串可作為存取API的參數。屬性工具連結  //open.taobao.com/api_tool/props/

#1、介面預覽

 

T1y4SlXip5XXaCwpjX.png

2、使用介紹

 

資料環境可選擇測試和正式,測試表示沙箱環境,正式表示正式環境。商品類目,可用taobao.itemcats.get 取得後台供賣家發布商品的標準商品類目取得。關鍵屬性和銷售屬性以及非關鍵屬性可用taobao.itemprops.get 取得標準商品類別目屬性取得。填選好相關參數點選提交就可以產生相關參數。顯示在右邊產生參數區域。一般用於發布產品和發布商品

 

三、錯誤碼排查工具#                 

#1、工具介紹

                                         則為

#

透過API 名稱和錯誤訊息,可以快速定位錯誤原因,從而可以幫助ISV自己快速解決呼叫TOP介面過程中遇到的問題。 存取位址: //open.taobao.com/apitools/errorCodeSearch.htm  。
                                                                                                                                                                                                                                 

2、操作步驟

############## ############

輸入API名稱(必填)與錯誤碼(或要求TOP取得完整的錯誤訊息),點選搜尋按鈕,取得到特定的錯誤訊息

T1Mp2iXcdrXXaCwpjX.png                                    

3、執行邏輯

1)只輸入API名稱,回傳該API下所有的業務錯誤碼資訊

2)輸入API名稱和特定的錯誤碼(錯誤body),傳回該API下特定的錯誤碼資訊.

3)如果未搜尋到,提示未找到改變錯誤訊息。 TOP會定期掃描,補充錯誤碼資訊。

                                  

#

4、具體#範例

1)只輸入API名稱,傳回該API下所有的業務錯誤碼資訊。

 T1iuTkXidhXXaCwpjX.png 

                                             

 

                             

#2)輸入API名稱與特定的錯誤碼(錯誤body ),傳回該API下具體的錯誤碼資訊。

                        或上

T12EvkXlRXXXaCwpjX.png                                                                                    

#3)輸入API名稱與錯誤Body,也就是請求top傳回的完整的錯誤訊息,json 或xml格式 

 

                           # 

                                              

#

4)點擊錯誤訊息連結,調到錯誤碼具體解釋頁面        #   

#:我們將持續的錯誤訊息最佳化

 T1EZPkXh8iXXaCwpjX.png                                             

 

 

#FAQ

  • 關於此文件暫時還沒有FAQ
#