API接口規范V1.0——制定好規范,才好合作開發


返回碼規范:

統一六位 000000 表示成功! 參數相關返回碼預留100000-199999;系統相關返回碼預留200000-299999;數據中心310000-319999后續項目以此類推,后續根據業務擴展情況新增操作碼需要提前備案!

module = 系統碼  optCode = 操作碼  optDesc = 操作描述  resultCode = 結果碼  resultDesc = 結果描述  bizCode = 業務碼  data = 返回數據

業務碼 = 系統碼- + 操作碼- + 結果碼   業務碼內容與之前定義的保持一致,實例:TaoBao- + Order_ADD- + 330002

返回結果示例如下所示:

異常返回:

{
   "optCode": "STORE_ADDMSG",
   "optDesc": "庫管中心新增消息",
   "resultCode": "330002",
   "resultDesc": "庫管中心新增消息失敗,添加消息到搜索引擎庫異常",
   "data": "",
   "module": "HME",
   "bizCode": "TaoBao-Order_ADD-330002",
   "success": false
}

正常返回:

{
   "optCode": "STORE_ADDMSG",
   "optDesc": "庫管中心新增消息",
   "resultCode": "000000",
   "resultDesc": "操作成功",
   "data": "",
   "module": "HME",
   "success": true,
   "bizCode": "Tao-Order_ADD-000000"
}

API文檔規范:

接口名稱:
products.search

接口描述:

中醫葯產品接口調用查詢

請求參數:

響應參數:

JSON返回示例:

{
   "optCode": "STORE_ADDMSG",
   "optDesc": "數據中心新增消息",
   "resultCode": "000000",
   "resultDesc": "操作成功",
   "data": "[
            {
         "keywords": null,
         "tymc": "阿莫西林",
         "tyjx": "顆粒劑",
         "projectId": "44AFC2328D63A53EE05012AC241E3E1B",
      }]",
   "module": "HME",
   "success": true,
   "bizCode": "HME-STORE_ADDMSG-000000"
}

服務碼參照:

結果碼參照:


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM