WiseCRM365 OpenAPI 簡介
簡介
WiseCRM365 OpenAPI 是基于 WiseCRM365 的服務接口。客戶通過接入和集成 OpenAPI 可以方便、高效地對相關業務或數據進行處理,與其他系統進行業務交互。WiseCRM365 OpenAPI 為已經開通了 OpenAPI 模塊的企業用戶提供服務。
基本調用規則
本文檔中列出的所有 API 基礎調用 URL 是 https://www.365.wisecrm.com/gw/
(特別指明的除外),如 API user/login-token
實際請求 URL 為 https://www.365.wisecrm.com/gw/user/login-token
。WiseCRM365 OpenAPI 目前支持 JSON 格式數據,后期將提供 XML 格式數據支持。
OpenAPI URL 規則:https://www.365.wisecrm.com/gw/[model]/[function]
通常,對于業務數據的操作主要包含新建、查詢(單記錄查詢、列表查詢)、更新、刪除,其對應的 [function]
如下
操作 | [function] | 示例 |
---|---|---|
新建 | add | account/add 新建客戶 |
獲取單條記錄 | get | account/get 查詢單條客戶記錄 |
查詢列表 | list | account/list 查詢客戶列表 |
修改 | update | account/update 修改客戶資料 |
刪除 | delete | account/delete 刪除客戶 |
RESTful API
WiseCRM365 OpenAPI 采用了 RESTful API 風格,它提供了 HTTP 的請求規范,多數的 API 需采用 POST 方式發送請求,少量的服務類 API 使用 GET 方式獲取數據。請注意,除 API 列舉的請求方式外,其他方法都不被支持。
WiseCRM365 OpenAPI 遵循統一的數據返回格式,例如:
{ "error_code":0, "error_msg":"調用成功", "data":xxx }
其中 data 為回傳的數據,error_code 為錯誤碼,error_msg 為錯誤描述,當 error_code 值為 0 時表示調用成功,其他值表示失敗。總體上可分為以下幾類錯誤碼:
- 0 請求成功
- 4XX 請求失敗(例如提供了不恰當的參數,具體出錯原因,會在 error_msg 中標注原因)
- 5XX 服務器錯誤(出現此錯誤,請聯系服務人員)
詳情參見 全局錯誤碼說明