一洽客服系统业务API接入指南

目录

1. 接口配置
2. 消息加解密说明
3. 根据接口文档实现业务逻辑

1.接口配置

使用管理者的权限登录一洽软件后，在更多设置-开放API页面中配置appId,消息加解密key（encodingAesKey),token.
如图：

配置信息说明：

appId：一洽系统自动生成的应用唯一值，用于接口交互时判断用户身份。

encodingAesKey（消息加解密key)：由开发者手动填写或随机生成，将用作JSON/XML数据加解密密钥，为保证数据安全推荐使用密文方式传输数据。

Token：Token可由开发者可以任意填写，用作生成签名

数据传输模式：明文：原始数据字符串 密文：通过AES加密过后的字符串

名词介绍：

apiServer：一洽提供给用户的接口服务器地址,例如：api.echatsoft.com

accessToken：调用一洽接口的授权令牌

ip白名单：允许访问一洽接口服务器的来源IP

2. 消息加解密说明

什么是EncodingAESKey？
一洽采用AES对称加密算法对消息体对行加密，EncodingAESKey则是加密所用的秘钥。消息接收方用此秘钥对收到的密文消息体进行解密。

消息加解密过程和微信公众平台的消息加解密方式一致。
示例代码（包括C++、php、Java、Python和C#版本）示例代码
注：一洽的签名信息在GET请求中，微信的示例代码签名在XML结构中，Encrypt节点的加解密方式是一样的。

Java要求jdk 1.6及1.6以上
异常java.security.InvalidKeyException:illegal Key Size的解决方案：在官方网站下载JCE无限制权限策略文件（请到官网下载对应的版本， 例如JDK7的下载地址：http://www.oracle.com/technetwork/java/javase/downloads/jce-7-download-432124.html 下载后解压，可以看到local_policy.jar和US_export_policy.jar以及readme.txt，如果安装了JRE，将两个jar文件放到%JRE_HOME%\lib\security目录下覆盖原来的文件；如果安装了JDK，将两个jar文件放到%JDK_HOME%\jre\lib\security目录下覆盖原来文件

3. 根据接口文档实现业务逻辑

一洽业务API是提供给用户以HTTP的方式主动的通过接口来获取以及实现一洽相关的业务（对话、留言、客服信息、路由、实时状态数据获取，自定义消息发送等），一洽客服系统业务API的使用流程大致如下：