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