CeMIAP EAS与AppServer编程接口参考手册.pdfVIP

1 目录 1 接口整体说明1 1.1 输入格式1 1.2 输出格式1 1.3 术语及约定2 2 EAServer 提供给业务服务器的接口2 2.1 Push 消息2 2.2 用户状态查询4 3 业务服务器提供给EAServer 的接口5 3.1 认证6 3.2 业务代理6 3.3 下载8 3.4 上传10 3.5 用户状态通知11 4 JSSE 提供给业务服务器的接口13 4.1 Push 消息13 修订记录 时间 修订人 修订内容 2012.8.6 wangfg 创建V0.1 1 接口整体说明 所有接口均采用 HTTP/HTTPS 协议，URL 中包括服务器 IP 和端口，格式为： http://IP:PORT/mobile 。输入参数以POST 方式提交，接口的输入/输出采用JSON 格式，编 码格式为UTF-8，基于流的接口（如上传、下载）的输出值格式将会在具体章节中详细的说 明。 1.1 输入格式 1. Post 方式，参数放在HTTP Body 中。 1.2 输出格式 本节对通用输出值格式做出具体描述。 对于输出内容的数据类型，包括：  布尔型(Boolean)：例如isNew:true|false，没有null 值  数字型(Number)：例如number:3.1415，没有null 值  字符串型(String)：例如name:’张三’，没有null 值，null 需要转化为’’(空串) 1  对象类型(Object)：null 表示空对象，{…}表示非空对象【只有Object 有 null 值】， 对象的属性可以是Boolean,Number,String,Object,Array.  数组类型(Array)：则[]表示空数组。没有null 值，null 需要转换为[]，数组的元素可 以是Boolean,Number,String,Object,Array 。 通用输出值的格式为JSON 格式，具体如下 { success:true|false, //是否成功，boolean error:’’, //错误信息，如果success=false，携带此信息，String errorCode:0, //错误代码，用于错误的分类，int data: //返回值，Object } 对于返回的结果，有以下几种情况： 1） success=true ：成功，此时error=null， errorCode=0，代表没有错误。其中data 为 返回的数据对象。data 只可能是Object 或Array 类型。 2 ） success=false ：失败，进一步查看errorCode 确定错误的分类以确定下一步操作。对 于每个接口来说，errorCode 的情况可能都不一样，具体说明见各个接口。其中 errorCode=2 是统一的，标识session 失效，需要重新登录。 1.3 术语及约定 日期格式：YYYY-MM-DD 时间格式：YYYY-MM-DD HH24:mi:SS 2 EAServer 提供给业务服务器的接口 本节详细描述了EAServer 提供给业务服务器的接口说明。EAServer 提供给业务服务器的 所有接口是一个地址，不同的接口通过commandId 区分。 接口的格式为JSON 。