API相關(guān)工具使用說(shuō)明
一、API測(cè)試工具
API測(cè)試工具,數(shù)據(jù)環(huán)境分為:測(cè)試(也稱(chēng)沙箱環(huán)境)、正式(包括應(yīng)用正式測(cè)試環(huán)境、上線運(yùn)行)。測(cè)試工具鏈接
//open.taobao.com/apitools/apiTools.htm
1、 在測(cè)試環(huán)境下使用API測(cè)試工具須注意3點(diǎn):
1)測(cè)試環(huán)境下的數(shù)據(jù)都是模擬線上的測(cè)試數(shù)據(jù),不能與線上數(shù)據(jù)混淆。
2)當(dāng)訪問(wèn)一個(gè)訪問(wèn)級(jí)別為“須用戶(hù)登錄",或須獲取訪問(wèn)級(jí)別為"隱私數(shù)據(jù)須用戶(hù)登錄"的隱私數(shù)據(jù)時(shí),就需要sessionkey.在測(cè)試環(huán)境下獲取SessionKey,見(jiàn)如何獲取sessionkey?。
3)可以自定義App Key,用自己申請(qǐng)的App Key和App Secret來(lái)測(cè)試。
4)如何獲取沙箱環(huán)境測(cè)試帳號(hào)?
【界面預(yù)覽】
2、在正式環(huán)境下使用API測(cè)試工具須注意3點(diǎn):
1)正式環(huán)境下的數(shù)據(jù)都是真實(shí)的數(shù)據(jù)。
2)用系統(tǒng)默認(rèn)的App Key測(cè)試時(shí),通過(guò)點(diǎn)擊“綁定用戶(hù)”并用商家賬號(hào)登錄淘寶網(wǎng)來(lái)獲取SessionKey,SessionKey有效時(shí)間為半個(gè)小時(shí)。如果要換商家測(cè)試,那么再次點(diǎn)擊“綁定用戶(hù)”重新獲取SessionKey即可。綁定成功后,點(diǎn)擊“提交測(cè)試”。
3)用自定義的App Key和App Secret測(cè)試時(shí),在正式環(huán)境下獲取SessionKey,見(jiàn)如何獲取sessionkey?。
【界面預(yù)覽】
3、常見(jiàn)問(wèn)題:
1)參數(shù)傳入錯(cuò)誤。一般是藍(lán)色星號(hào)的參數(shù)沒(méi)有傳入。紅色星號(hào)的參數(shù)為必傳參數(shù)。還可能傳入?yún)?shù)格式或者類(lèi)型不對(duì)。錯(cuò)誤排查參考錯(cuò)誤碼一覽文檔、快速排查問(wèn)題、錯(cuò)誤碼排查工具。
2)點(diǎn)擊提交測(cè)試沒(méi)反應(yīng)。清除緩存或者換瀏覽器,但少數(shù)接口確實(shí)需要一定時(shí)間才能生成返回結(jié)果,如taobao.trades.sold.get 搜索當(dāng)前會(huì)話用戶(hù)作為賣(mài)家已賣(mài)出的交易數(shù)據(jù)。
3)接口調(diào)用限制只能塔內(nèi)調(diào)用,如何使用測(cè)試工具。
在開(kāi)發(fā)者中心后臺(tái)——聚石塔本地測(cè)試添加需要測(cè)試的nick,就可以進(jìn)行塔外IP測(cè)試了。
二、API屬性工具
API屬性工具,它的主要功能是生成商品屬性(props)、銷(xiāo)售屬性(sku_properties)、自 定義類(lèi)目屬性(input_pids)和自定義屬性值(input_str)。首先,選擇商品類(lèi)目,然后填寫(xiě)屬性表單,最后點(diǎn)擊“提交”就生成各種屬性串 了。帶*的為商品的必須屬性,生成的屬性串可作為訪問(wèn)API的參數(shù)。屬性工具鏈接 //open.taobao.com/api_tool/props/
1、界面預(yù)覽
2、使用介紹
數(shù)據(jù)環(huán)境可選擇測(cè)試和正式,測(cè)試表示沙箱環(huán)境,正式表示正式環(huán)境。商品類(lèi)目,可用taobao.itemcats.get 獲取后臺(tái)供賣(mài)家發(fā)布商品的標(biāo)準(zhǔn)商品類(lèi)目獲取。關(guān)鍵屬性和銷(xiāo)售屬性以及非關(guān)鍵屬性可用taobao.itemprops.get 獲取標(biāo)準(zhǔn)商品類(lèi)目屬性獲取。填選好相關(guān)參數(shù)點(diǎn)擊提交就可以生成相關(guān)參數(shù)。顯示在右邊生成參數(shù)區(qū)域。一般用于發(fā)布產(chǎn)品和發(fā)布商品。
三、錯(cuò)誤碼排查工具
1、工具介紹
通過(guò)API 名稱(chēng)和錯(cuò)誤信息,可以快速定位錯(cuò)誤原因,從而可以幫助ISV自己快速解決調(diào)用TOP接口過(guò)程中遇到的問(wèn)題。訪問(wèn)地址: //open.taobao.com/apitools/errorCodeSearch.htm 。
2、操作步驟
輸入API名稱(chēng)(必填)和錯(cuò)誤碼(或者請(qǐng)求TOP獲取完整的錯(cuò)誤信息),點(diǎn)擊搜索按鈕,獲取到具體的錯(cuò)誤信息
3、執(zhí)行邏輯
1)只輸入API名稱(chēng),返回該API下所有的業(yè)務(wù)錯(cuò)誤碼信息。
2)輸入API名稱(chēng)和具體的錯(cuò)誤碼(錯(cuò)誤body),返回該API下具體的錯(cuò)誤碼信息。
3)如果未搜索到,提示未找到改錯(cuò)誤信息。TOP會(huì)定期掃描,補(bǔ)充錯(cuò)誤碼信息。
4、具體示例
1)只輸入API名稱(chēng),返回該API下所有的業(yè)務(wù)錯(cuò)誤碼信息。
2)輸入API名稱(chēng)和具體的錯(cuò)誤碼(錯(cuò)誤body),返回該API下具體的錯(cuò)誤碼信息。
3)輸入API名稱(chēng)和錯(cuò)誤Body,即請(qǐng)求top返回的完整的錯(cuò)誤信息,json 或xml格式
4)點(diǎn)擊錯(cuò)誤信息鏈接,調(diào)到錯(cuò)誤碼具體解釋頁(yè)面
注:我們會(huì)不斷的對(duì)該錯(cuò)誤信息進(jìn)行優(yōu)化
FAQ
- 關(guān)于此文檔暫時(shí)還沒(méi)有FAQ