<#import "/ftl/spring.ftl" as spring/> <@spring.message code="doc.page.title"/> <@mdp.mdp_index_common/> <@mdp.mdp_index_top/>
移动警务开放平台接口调用 更新时间:2015-10-11
移动警务开放平台
接口调用说明书

1前言

1.1编写目的

为方便第三方开发者顺利接入开放平台,本文档对开放平台对外开放接口提供接口说明。

1.2预期读者
  • 第三方应用开发者
1.3术语、定义、符号及缩略语
缩写。术语 解释
DRS 数据请求服务
UAS 统一授权认证服务器

2概述

2.1简述

移动警务开放平台(以下简称开放平台)提供一个基本的服务,然后通过开放自身的接口,使得第三方开发者得以通过运用和组装其接口以及其他第三方服务接口产生新的应用,并且使得该应用能够统一运行在这个平台之上。

第三方整体接入开放平台涉及 资源发布、资源申请、资源调用、统一认证、用户同步、应用上线、应用升级以及PAMS审批各种申请。

2.2参考资料

本文档仅对接入开放平台涉及接口进行统一说明,接口外说明详见《移动警务开放平台用户手册 .doc》

3资源调用
3.1资源调用说明

资源分业务资源、网络资源、数据源资源

业务资源:

数据源地址:从开放平台页面申请资源和查阅

接口:第三方提供方提供接口调用方式,从开放平台资源下载页获取

网络资源:

数据源地址:从开放平台页面申请资源和查阅

接口:第三方提供方提供接口调用方式,从开放平台资源下载页获取

数据源资源:

数据源地址:从开放平台页面申请和查阅(开放平台DRS系统接口地址)

接口:DRS接口(详见本文1.3)

注:数据源资源是接入数据请求服务DRS系统的数据源统称,支持增删改查、多 数 据源、字典翻译等基础功能。本文档仅对该种资源进行接口调用说明。
3.2资源调用流程
流程图

可以直接申请其他第三方上传的资源

3.3数据源资源接口

查询接口:QueryResult query(QueryRequest queryParam)

查询请求参数说明:

属性名 类型 含义 备注
localTable String 本地表名 数据请求服务
localFields String 本地表字段 传*查询所有字段
condition String 条件 不带where关键字的查询子句
dsid String 数据源ID 缺省值*
pageNumber int 页码
pageSize int 每页大小
uuInfo UserUnitInfo 调用者信息

UserUnitInfo对象说明:

属性名 类型 含义 备注
policeName String 警员姓名 后台调用此值留空
policeSfzh String 警员身份证号 后台调用此值留空
unitCode String 单位代码
unitName String 单位名称
zdbs String 终端标识 终端调用此值为终端硬件标识,比如手机的IMEI;后台调用此值为调用者IP

查询返回结果参数说明:

属性名 类型 含义 备注
state int 成功标识 0成功,1失败
errMsg String 失败时的错误描述
rowTotal String 总记录数
currRows String 当前页记录数
localTable String 本地表名
localFields []String 本地表字段 提供几个返回几个,传*返回全部字段
rows List <\Data[]\> 数据列表 每个Data[]代表一行数据,数据索引同字段名顺序

Data对象说明:

属性名 类型 含义 备注
value String 字段值 以性别男举例:isCode=true时,codeValue=1value=男以姓名举例:isCode=false;codeValue为空;value=张三
isCode boolean 是否经过翻译
codeValue String 字典值
3.3.2采集接口

录入接口:IDUResult executeIDU(IDURequest iduParam)

录入请求参数说明:

属性名 类型 含义 备注
version String 录入协议版本号
transactionType int 事务类型 目前固定为1
uuInfo UserUnitInfo 调用者信息 同查询
table List <IfaceTable > 输入表信息

IfaceTable对象说明:

属性名 类型 含义 备注
name String 表名
mainTable boolean 是否主表 主表只能有1个
row List &IfaceRow > 行信息

IfaceTable对象说明:

属性名 类型 含义 备注
type type DataOperateType枚举 表名 不能是query
srcCondition String 更新或删除操作的条件 插入时此值留空
column List &IfaceColumn > 列信息 插入操作的列

IfaceColumn对象说明:

属性名 类型 含义 备注
name String 字段名(小写)
value String 字段值

录入返回结果说明:

IDUResult对象说明:

属性名 类型 含义 备注
state int 录入状态 0成功,1失败
errMsg String 失败时的错误描述
3.4示例代码

示例代码及第三方JAR包请查阅《数据源资源调用.rar》

4统一认证
4.1统一认证说明

开放平台是一个统一管理的平台,通过授权,应用的用户信息应是统一的,统一认证客户端给第三方提供统一的用户授权认证。

授权访问平台对公安内网的网络应用程序接口进行集中管理、访问授权,并对外提供统一的访问接口。

4.2统一认证客户端调用流程
流程图
时序图
4.3接口
4.3.1票据获取接口

该功能主要用于第三方应用接入开放平台的统一入口,拿到入口票据,才可与第三方业务后台进行通信。

通过ContentProvider的query方法访问统一认获取票据,票据获取URI定义如下: content://com.xdja.app.pj/调用程序的包名

如果统一认证中没有票据信息,会自动拉起登录,进行登录认证,登录成功后,统一会以广播的形式通知第三方应用,广播的Action为第三方应用的包名(注:使用BroadcastReceiver进行接收)。

票据获取接口返回结果:

列名 说明 类型
resultCode 错误代码 0:认证成功 -99 未知错误
-1:票据信息为空 -2:权限被拒绝
-3:传入信息错误 -4:票据信息已过期
message 错误信息
billStr 票据信息 加密数据
4.3.2单点登出接口

该功能主要用于用户注销操作,在统一认证管理的的应用中,其中一个应用请求注销成功,其它被管理的应用也需要同时注销,才能达到单点登出的效果。

通过ContentProvider的delete方法,进行单点登出,单点登出URI定义如下:

content://com.xdja.app.pj/调用程序的包名

调用后会删除缓存中票据信息,统一认证会发送广播,通知有应用登出,并将请求登出应用的包名放在Intent中的packageName键中(注:使用BroadcastReceiver进行接收)。

单点登出广播定义:

"com.xdja.unifyauthorize.ACTION_LOGOUT"

请求登出应用包名参数:

"packageName"

单点登出接口返回结果:

列名 说明 类型
resultCode 错误代码 0:登出成功 -2:权限被拒绝
4.4示例代码

示例代码请查阅《统一认证客户端调用部分代码示例.rar》

请查看附件
<@mdp.mdp_index_bottom/>