安邦保趣手机客户端接口设计方案0119.docVIP

安邦“保趣”手机客户端软件接口设计方案 接口协议规范 请求数据 请求数据：请求格式如下 请求标识$参数名=参数值|参数名=参数值!参数名=参数值|参数名=参数值 1.$前面是该次请求的标识，表示由哪个后台服务来处理。 2.!前面是该次请求的系统特殊参数，分隔符说明同下，可选填。 第一行带列名，后面的行不用带。 例如： AC01$ec=t!platform=java 返回结果：记录集 返回值：返回格式如下 请求标识$返回状态-特别参数名=特别参数值!记录集标识*每页记录数@列索引i列名=列值|列名=列值|列名=列值#列值|列值|列值%记录集标识*每页记录数@列索引i列名=列值|列名=列值|列名=列值#列值|列值|列值 1.$前面是该次请求的标识，表示由哪个后台服务来处理。 2.!前面是该次请求的系统特殊参数，分隔符说明同下，可选填。 3. * 前面是记录集名称 4. @前面是每页记录数，可选填 5. i前面是页索引，代表第几页(从1开始编码)，可选填 6. =用来分割属性与值 7. |用来分割列与列 8. #用来分割行与行 9. %用来分割记录集与记录集 第一行带列名，后面的行不用带。 注：只有查询数据，后台返回结果集时会用到此方式。 例如： AC02$key=123121!ListA*2@1iusername=小王|ID=430321# 1i小李|430321%ListB*3@2ilcnNo=京A001|brndCde=12345| useAttr=自用#1i京A002|33311|公交车 返回结果：一般返回结果 请求标识$返回状态-特别参数名=特别参数值!值|值|值 返回状态与值之间用-分隔 值与值用|分隔 3.!用于返回给客户端传递特别参数，属性名与属性值的分隔符用法同上。可选 4.=用来分割属性与值, 传递特别参数时用。 5.|用来分割列与列, 传递特别参数时用。 顺序双方事先指定好。 示例： 获得唯一标识返回 例如：200(返回状态-ID) 该车牌号是否报案返回 例如：1-已报案(报案状态-说明)注：任何状态最好都带下来详细准确的说明。 获得ID绑定的车牌号返回 例如：200-津A23289(返回状态-车牌号) 返回多个车牌号返回 例如：200-津A23289|津A11122(返回状态-车牌号|车牌号…) 4. 上传图片如果请求带有图片ID，返回时请赋加上ID返回 例如：200-1(返回状态-ID) 5. 上传数据返回。例如：200(返回状态) 注意： 所以数据区分大小写，包括URL请求及参数等。 不要携带不必要的空格，值中包含空格的除外。 分隔符号一律用英文输入状态下的（不识别中文分隔符）。 接口详细描述 后台提供两类接口服务，一个是面向数据流的，一个是面向图片流的。 针对两类接口后台提供两个对应的URL服务地址，具体远程调试地址，部署后另行告知。 具体说明： 所以请求均以POST方式发送。 URL后面不加任何参数。 图片文件以字节流格式传输，传图片流的请求里需要携带参数的，放在HTTP的头（header）里面，具体参数详见接口。 数据流请求的HTTP头里面不附加任何参数。 字符编码格式UTF-8 用户登录接口设计 登录 RemoteLogin:Service a)描述 对外提供统一用户登录接口，通过HTTP协议验证用户名密码。 BQ01 Required Name Type Description required username String 登录的用户名(邮箱帐号 或者 手机号) required password String 登录密码 required platform String 平台类型 iphone,java,linux,wm, android, symbian 示例如下： BQ01$username=158011123212|password=1234| platform=java d）返回参数列表 Name Type Description success int 成功标识 200表示成功；201表示失败 returnMsg string 返回信息 如果成功，此值为唯一ID（KEY），失败 为描述信息 ifActive string 激活状态 1：已激活；2未激活 示例如下： 成功：BQ01$200