2024政务信息共享平台数据开放接口规范.docx

政务信息共享平台数据开放接口规范

目录

前言 1

1、范围 2

2、规范性引用文件 2

3、术语和定义 2

接口功能概述 2

URL 3

API 3

accessApplicationModel数据结构 3

政务信息共享平台数据信息资源 3

对象访问协议 3

4、格式约定 3

5、接口要求 4

、公共请求参数 4

、返回结构 4

、字符编码 4

、鉴权机制 4

请求样例 6

6、数据定义 7

、数据源Json数据结构 7

请求样例 8

返回样例 8

成功返回 8

失败返回 9

7、数据类型 9

PAGE

PAGE10

政务信息共享平台数据开放接口规范

1、范围

本标准规定了本公司内关于相关标准编写的内容、格式及结构。

本标准适用于本公司内各部门的技术标准、管理标准、工作标准的制（修）订。

本标准规定了城市政务信息共享平台事件服务接口的要求。本标准适用于本公司生产及销售的政务信息共享平台系统。本标准介绍城市政务信息共享平台相关接口标准规定。

2、规范性引用文件

GB8566-88计算机软件开发规范

GB/T20001.10-2014标准编写规则

GB/T2260-2002中华人民共和国行政区划代码

GB2312-1980信息交换用汉字编码字符集

GB/T4880.2语种名称代码第2部分：3字母代码

GB/T7408数据元和交换格式、信息交换、日期和时间表示法

GB13000.1-1993信息技术通用多八位编码字符集（UCS）第1部分：体系结构与基本多文种平面

3、术语和定义

下列术语和定义适用于本标准

接口功能概述

1、实现多数据源数据采集（网站、论坛、呼叫中心数据库、邮件、文件系统、纸质文件）的数据，能够与信息技术服务知识库的知识资源库实现无缝对接。

2、 接收提取的关键词。

URL

在WWW上，每一信息资源都有统一的且在网上唯一的地址，该地址就叫URL（UniformResourceLocator,统一资源定位器），它是WWW的统一资源定位标志，就是指网络地址。

API

API（ApplicationProgrammingInterface，应用程序接口）是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。[1]用来提供应用程序与开发人员基于某软件或硬件得以访问的一组例程，而又无需访问源码，或理解内部工作机制的细节。

accessApplicationModel数据结构

该结构定义应用管理（新增，修改，查询）所使用到的json

政务信息共享平台数据信息资源

政务信息共享平台数据信息资源相关的数据集、档案、文件、报告和服务，具体形式是数据库、图片、文档、音视频和服务等。

对象访问协议

一种轻量的、简单的、基于XML的协议，它被设计成在WEB上交换结构化的和固化的信息。

4、格式约定

格式

说明

“”

带双引号“”的格式表示各类界面控件名称、窗口名称、按钮名称和

数据表，如单击“保存”。

多级菜单用“”隔开。如选择“开始控制面板系统和安全”，表示到

“系统和安全”的路径。

斜体

可变参数（如IP、路径等需在使用中由实际值代替的部分）采用斜

体表示。

5、接口要求

、公共请求参数

http状

态码

描述

code

说明

备注

200

请求成功

-

-

-

302

重定向，为了完成请求，必须进一步执行的动作

30201

重定向

访问返回数据中的链接

400

BadRequest缺失参数，参数格式不正确

40001

缺少必选参数

根据提示检查调用参数

40002

非法的参数

根据提示检查

调用参数

N/A

N/A

N/A

401

Unauthorized没有授权

40101

没有授权

需要授权，XXXX

404

NotFound请求的资源不存

在

N/A

N/A

N/A

其他

失败

N/A

N/A

N/A

、返回结构

参数名

说明

类型

code

返回code

Integer

data

返回数据集

N/A

message

返回信息

String

{

code:20000,message:保存成功,data:{“id”:123}

}

、字符编码

请求及返回结果都使用UTF-8字符集进行编码。

、鉴权机制

Digest认证时，用户访问该API时需要在HTTP请求头中携带

Authorization，Authorization

值对应格式为：

名称描述code返回

名称

描述

code

返回code

Algorithm

用于计算签名的算法，为HMAC-SHA256

Tim