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 时表示调用成功,其他值表示失败。总体上可分为以下几类错误码:

详情参见 全局错误码说明

© WiseCRM365 上海企能软件科技有限公司    |    编辑本页