步驟一:登陸菜鳥賬號
請按照賬號登錄指引完成賬號注冊和登陸。
如果您已有菜鳥賬號,請忽略此步驟。
步驟二:明確需要的場景
菜鳥開放平臺提供多種快速接入場景,您可以在概覽頁面查看全量場景合集,通過場景接入的應用可快速審核通過。
不同的場景下包含了不同的API合集,提供的服務能力也不同。具體場景下的能力集合請查看:無憂物流場景、國際快遞場景
步驟三:快速接入
選擇了場景后,點擊右下角的快速接入
您需要配置以下信息:
-
應用名稱:一般為中英文組成,不含有特殊字符
-
資質類型:
選擇你使用該應用訪問時需要的資質類型,不同的場景所需的資質條件不同,如果您沒有特殊資質類型,可選擇普通用戶進行測試,如果您有其他身份,請先完成資質認證。
-
配置API信息
場景下已經(jīng)預置好訂閱和注冊的API列表,您也可以根據(jù)自身需要做響應的篩選,取消掉不需要的API(請事先跟業(yè)務對接人確認好所需要的API)。
訂閱API:由您來訂閱菜鳥提供的API服務,您可以使用所創(chuàng)建的應用身份來完成調用訪問。
注冊API:您需要將自己的后端服務注冊到該API上,將數(shù)據(jù)或信息通過此API傳遞給菜鳥。
字段脫敏申請:API涉及到敏感字段信息默認脫敏,如果您需要獲取到這些字段的明文,請點擊字段脫敏申請提交審核。
修改配置:您可以修改API的編碼格式和報文格式;注冊API的配置修改,可以設置兩個訪問地址,其中聯(lián)調請求地址是您若需正式上線前與菜鳥聯(lián)調,菜鳥將會調用您的聯(lián)調請求地址,聯(lián)調結束后再調用真實請求地址。
-
完成接入
以上操作完成后,系統(tǒng)將自動完成應用創(chuàng)建、訂閱API、注冊API和驗證,通過場景接入的應用可快速審核通過。
步驟四:開始聯(lián)調
-
應用上線后,點擊更多->進入聯(lián)調,可以進入聯(lián)調任務管理列表
-
您可以在該列表查看聯(lián)調所需的所有任務和用例
-
點擊任務詳情,查看每個任務下的用例執(zhí)行情況
-
點擊執(zhí)行用例,您可以對該用例做對應的請求下發(fā)測試,觀察返回結果是否符合預期