接口梳理7個注意點總結

①注意要測試環境和生產環境。生產上線時候要提醒研發換到生產環境調用。

②注意必輸字段和選輸字段，要傳入字段的含義和校驗。枚舉值不清楚含義的要詢問對方含義，比如說單據類型字段枚舉值是B2C發貨單，BBC發貨單，采購退貨發貨單等..

③注意唯一ID之間的關聯，比如說我們訂單系統的發貨單號是001，到wms系統是否生成了一個新單號A001,那發貨回執時候wms要給ODS系統001單號。

1688 API 接入說明

1. API地址:

2. 調用示例：

3. 參數說明

   • 通用參數說明

     • version:API版本
     • key:調用key,測試key:test_api_key
     • api_name:API類型[item_get,item_search]
     • cache:[yes,no]默認yes，將調用緩存的數據，速度比較快
     • result_type:[json,xml,serialize,var_export]返回數據格式，默認為json
     • lang:[cn,en,ru] 翻譯語言，默認cn簡體中文

   • API:item_get 參數說明: num_iid:寶貝ID

4. 此API目前支持以下基本接口：

   • item_get 獲得1688商品詳情
   • item_search 按關鍵字搜索商品
   • item_search_img 按圖搜索1688商品（拍立淘）
   • item_search_suggest 獲得搜索詞推薦
   • item_fee 獲得商品快遞費用
   • seller_info 獲得店鋪詳情
   • item_search_shop 獲得店鋪的所有商品
   • item_password 獲得淘口令真實url
   • upload_img 上傳圖片到1688
   • item_search_seller 搜索店鋪列表
   • img2text 圖片識別商品接口
   • item_get_app 獲取1688app上原數據
   • buyer_order_list 獲取購買到的商品訂單列表
   • cat_get 獲得1688商品分類

?

④注意基礎信息的映射。比如說倉庫代碼和對方倉庫代碼是否一樣，商品編碼和對方商品編碼是否一樣。如果不一樣還要進行映射，那映射的工作是誰來做。

⑤注意行信息和明細（我們常說的list）數據。哪些在行中，哪些在明細中，看的是單據和字段的關系，是一對一還是一對多，一對一就在行中，一對多就在明細中。比如說發貨單只有一個發貨倉，那么就是在行中，但是一個發貨單有多個商品，那就在明細中。

行中部分數據和明細中的數據對的上，比如說發貨單總金額=∑商品行總金額（商品單價*數量），發貨單總實付金額=∑商品行實付金額（實付價*數量）。實付金額≠總金額，因為還存在促銷活動使用優惠券等。那下游為什么要有這個字段呢？如果這個字段值我給的不精確會有什么影響呢？這都是要和下游溝通的，比如說下游發貨保價，他是根據哪個價格保的，這樣你就能判斷哪些字段傳的精確不精確的影響。

⑥接口文檔字段的校驗，比如說發貨單下發Wms，wms會校驗商品是否存在，倉庫是否存在等，這些校驗服務于業務需要，比如說商品都不存在，我怎么發貨呢對吧，所以雙方系統的基礎數據要對齊。

⑦同步方式：增量和全量。這個一般在做基礎數據同步的時候，比如說商品檔案，會員信息等。增量指的是增加的變動的推送給其他系統，全量是定時比如每天推一下全部的數據。

接口文檔常用名詞整理

同步和異步。同步指的是同一時間處理，異步指的是不能實時處理，處理完結果再告知結果，會新增接口對接。

拉取和推送。一般接口遵從誰是數據上游方，推送給下游。但是如果1個上游方對應N個下游方，這個時候上游機會提供拉取接口，下游都來拉數據。這樣因為減少上游方開發工作量。上報聯調。跨系統對接時把接口調通。

Mock。有時候上下游沒時間和開發聯調，這個時候開發可以造數據自己先調。一般開發用postman工具mock接口。

調用地址/URL。生產環境測試環境

API接口和MQ。MQ【消息隊列/消息中間件】可以用于內部系統對接非實時部分，具體看研發設計。