华阳向线下CRM的接口文档_V0.2.doc

深圳市华阳信通科技发展有限公司 深圳市华阳信通科技发展有限公司 华阳向线下CRM提供的接口 说明文档 <版本0.2> 文档修订控制 序号 版本号 修订日期 修订概述 修订人 审批人 1 0.1 2016/4/20 建立 徐彬森 2 0.2 2016/4/26 更新，增加1.5接口调用示例 徐彬森 目 录 TOC \o "1-3" \h \z \u 1. 引言 5 1.1. 目的 5 1.2. 范围 5 1.3. 接口地址 5 1.4. 接口规范 6 1.4.1. 通信方式 6 2. 接口服务说明 7 2.1. 获取accessToken 7 2.1.1. 接口请求说明 7 2.1.2. 接口响应说明 7 2.2. 获取自定义字段信息 8 2.2.1. 接口请求说明 8 2.2.2. 接口响应说明 8 2.3. 同步用户信息 9 2.3.1. 接口请求说明 9 2.3.2. 接口响应说明 10 2.4. 根据微信openId获取用户信息 10 2.4.1. 接口请求说明 10 2.4.2. 接口响应说明 11 2.5. 根据手机号码获取用户信息 12 2.5.1. 接口请求说明 12 2.5.2. 接口响应说明 13 2.6. 用户储值 14 2.6.1. 接口请求说明 14 2.6.2. 接口响应说明 15 2.7. 用户取消储值 15 2.7.1. 接口请求说明 15 2.7.2. 接口响应说明 16 2.8. 用户消费 16 2.8.1. 接口请求说明 16 2.8.2. 接口响应说明 17 2.9. 用户取消消费 18 2.9.1. 接口请求说明 18 2.9.2. 接口响应说明 19 2.10. 使用积分 19 2.10.1. 接口请求说明 19 2.10.2. 接口响应说明 20 2.11. 获得积分 20 2.11.1. 接口请求说明 20 2.11.2. 接口响应说明 21 2.12. 支付密码验证 22 2.12.1. 接口请求说明 22 2.12.2. 接口响应说明 22 2.13. 根据时间分页查询用户信息列表 23 2.13.1. 接口请求说明 23 2.13.2. 接口响应说明 23 3. 响应编码列表 26 引言 目的 为了提高系统对接双方的工作效率，本文档规定CRM与华阳对接的协议与规范。是华阳对外开放REST接口的标准文档。 范围 提供接口内容：已发布服务（即文档所提供的接口方法） 调用接口对象：已注册应用，获取调用权限（根据appId和appSecret获取accessToken） 接口地址 * 开发环境: /crm * 测试环境: /crm * 生产环境: /crm 注：根据实际情况选用接口地址。如线上生产环境选生产环境，接口对接联调时选测试环境或者开发环境。 接口规范 通信方式 接口通信协议统一使用HTTP协议 字符集统一使用UTF-8 接口方法请求方式统一使用POST 返回格式JSON 接口调用示例 调用格式：接口地址/方法名 调用示例：获取accessToken 请求地址：正式环境 /crm/ getAccessToken 请求参数：{"appId":"XXXXXX","appSecret":"XXXXXX"} 响应参数： {"code":"00","msg":null,"accessToken":"m3+/1cA+AOH4sJBh5EvA3sDV2Rw=","expiresIn":7200} 接口服务说明 获取accessToken 接口请求说明 调用地址 接口地址/getAccessToken 方法描述 根据appId和appSecret获取accessToken 请求参数描述 参数 名称 类型 允许为空 备注 appId 应用编号 String N appSecret 应用密钥 String N 接口响应说明 响应参数描述 参数 名称 类型 参考值 备注 code 响应码 String 00 参考响应编码列表 msg 响应消息 String null 请求成功返回null,否则返回错误信息。 accessToken 唯一凭据 String 唯一凭据 expiresIn 有效时长 String 7200 单位：秒 获取自定义字段信息 接口请求说明 调用地址 接口地址/getCustomColumnsInfo 方法描述 特殊属性字段配置 请求参数描述 参数 名称 类型 允许为空 备注 accessTok