接口调用说明文档

2024年2月8日发(作者：)

v1.0

可编辑可修改

XXXX科技有限公司

数据接口

2015-5-26

1

第 1

页共 13 页

v1.0

可编辑可修改

目 录

章 引言 ..........................................................................................................................................................

1.1

背景 .......................................................................................................................................................

章 接口与数据定义 ......................................................................................................................................

2.1

曝光台查询接口 ...................................................................................................................................

2.1.1

曝光台列表查询 ........................................................................................................................

2.1.2

曝光台详情查询 ........................................................................................................................

2.2

信用公示查询接口定义 .......................................................................................................................

2.2.1

守信公示列表查询 ....................................................................................................................

2.2.2

守信公示详情查询 ....................................................................................................................

2.2.3

失信公示列表查询 ....................................................................................................................

2.2.4

失信公示详情查询 ....................................................................................................................

2.3

企业名称查询接口定义 .....................................................................................................................

2.3.1 Webservice方法定义 .................................................................................................................

2.3.2

请求参数 ..................................................................................................................................

2.3.3

返回数据 ..................................................................................................................................

2.4

企业信息查询接口定义 .....................................................................................................................

2.4.1 Webservice方法定义 .................................................................................................................

2.4.2

请求参数 ..................................................................................................................................

2.4.3

返回数据 ..................................................................................................................................

2

第 2

页共 13 页3

3

4

4

4

5

6

6

7

8

9

10

10

10

10

11

11

11

11

第 1第 2

v1.0

可编辑可修改

第 1章 引言

1.1 背景

为进一步保证业务的正确性及数据的安全统一性，并为后续各方开发工作提供指导，特编写此文

档。

本接口通过

Webservice

方式进行交互，由市公共信用中心提供信息查询

Webservice

服务，供经授权的调用使用。

3

第 3

页 共 13 页

v1.0

可编辑可修改

第 2章 接口与数据定义

2.1 曝光台查询接口

2.1.1

曝光台列表查询

2.1.1.1

方法定义

访问地址：

曝光台 Webservice 接口及参数定义如下

:

数据类型

空

序号

方法名

方法参数

注释

1

queryBGTList

空

查询曝光台列表信息（

回最新的

50 条数据 ）

该方法默认返

示例代码 (Java) : public String

queryBGTList

( ) {/*todo*/}

2.1.1.2

返回数据

返回数据为字符串，内容格式为

json ，格式样板如下：

[{"id":"94a349902",

"title":"

江苏省 2014 年 12 月份违法药品医疗器械保健食品广告公告

",

"createTime":"2015-05-15"},

{"id":"94a349e04",

"title":"

省食品药品监督管理局暂停销售利肺胶囊等

2 个药品的公告 ",

"createTime":"2015-05-15"},

{"id":"94a2432e24",

"title":"

江苏省 2014 年 5 月份违法药品医疗器械保健食品广告公告

4

",

第 4

页 共 13 页

v1.0

可编辑可修改

"createTime":"2015-05-15"}]

序号 节点标示 节点名称 数据类型

1

2

3

Id

Title

createTime

编号

标题

时间

String

String

String

2.1.2

曝光台详情查询

2.1.2.1

方法定义

曝光台 Webservice 接口及参数定义如下

:

数据类型

注释

序号

方法名

方法参数

1

queryBGTDetail

Id

String

查询指定的某条曝光台新闻详情

示例代码 (Java) : public String

queryBGTDetail

(String id ) {/*todo*/}

2.1.2.2

返回数据

返回数据为字符串，内容格式为

json ，格式样板如下：

{"title":"

江苏省 2014 年 12 月份违法药品医疗器械保健食品广告公告

",

"content":"

根据《江苏省药品监督管理条例》第三十二条的规定，我局经研究决定，

2 种违法广告

自 2015 年 2 月 15 日起，对标示为吉林通化百信药业有限公司利肺胶囊等

药品（品种名单见附件）采取暂停销售措施，在我省范围内暂停上述

2 品种的销售，现

予以公告。 "}

序号 节点标示 节点名称 数据类型

1

2

Title

Content

5

标题

内容

String

String

第 5

页 共 13 页

v1.0

可编辑可修改

2.2 信用公示查询接口定义

2.2.1

守信公示列表查询

2.2.1.1

方法定义

访问地址：

曝光台 Webservice 接口及参数定义如下

方法参数

:

注释

序号

方法名

数据类型

1

1

querySHOUXINList

空

查询守信公示列表信息 （该方法默认

返回最新的

50 条数据 ）

示例代码 (Java) : public String

querySHOUXINList

( ) {/*todo*/}

2.2.1.2

返回数据

返回数据为字符串，内容格式为

json ，格式样板如下：

[{"id":"94a349902",

"title":"

2014 年度江苏省价格诚信单位名单

",

"createTime":"2015-05-15"},

{"id":"94a349e04",

"title":"

【单位】苏州市水利工程有限公司

",

"createTime":"2015-05-15"},

{"id":"94a2432e24",

"title":"

市政府办公室关于表彰

2012 年度全市政府信息公开工作优秀单位的通报

",

"createTime":"2015-05-15"}]

序号 节点标示 节点名称 数据类型

1

2

Id

Title

6

编号

标题

String

String

第 6

页 共 13 页

v1.0

可编辑可修改

3

createTime

时间

String

2.2.2

守信公示详情查询

2.2.2.1

方法定义

曝光台 Webservice 接口及参数定义如下

:

数据类型

注释

查询指定的某条守信公示详情

序号

方法名

方法参数

1

querySHOUXIil

Id

String

示例代码 (Java) : public String

querySHOUXINDetail

(String id ) {/*todo*/}

2.2.2.2

返回数据

返回数据为字符串，内容格式为

json ，格式样板如下：

{"title":"

江苏省 2014 年 12 月份违法药品医疗器械保健食品广告公告

",

"content":"

各市、区人民政府，苏州工业园区、苏州高新区管委会；市各有关部门和单位：

，进一步建立健全政府信

2012

年，各地各部门认真贯彻《中华人民共和国政府信息公开条例》

息公开工作制度，深化公开内容，丰富公开载体，拓展公开范

围，不断提高政府信息公开的

及时性、完整性和实用性，较好地发挥了政府信息对人民群众生产、生活和经济社会活动的

服务作用。根据《市政府办公室关于开展

2012

年度全市政府信息公开工作考核的通知》

（苏

府办〔 2013〕14 号）精神，综合各地自查、平时检查、网上测评和实地调研考核等方面情况，

经市政府 同意，决定对昆山市人民政府办公室、苏州市发改委等政府信息公开工作优秀单位

予以通报表彰。各地各部门要以先进为榜样，进一步加强组织领导，完善工作机

制，强化制

度建设，加大公开力度，不断提升政府信息公开整体工作水平。

附件： 2012 年度全市政府信息公开工作优秀单位

"}

7

第 7

页 共 13 页

v1.0

可编辑可修改

序号 节点标示 节点名称 数据类型

1

2

Title

Content

标题

内容

String

String

2.2.3

失信公示列表查询

2.2.3.1

方法定义

曝光台 Webservice

接口及参数定义如下

序号 方法名 方法参数

:

数据类型

注释

查询失信公示列表信息（该方法默认返回

最新的 50 条数据）

1

querySHIXINList

空

空

示例代码 (Java) : public String

querySHIXINList

( ) {/*todo*/}

2.2.3.2

返回数据

返回数据为字符串，内容格式为

json ，格式样板如下：

[{"id":"94a349902",

"title":"

2014 年度江苏省价格诚信单位名单

",

"createTime":"2015-05-15"},

{"id":"94a349e04",

"title":"

【单位】苏州市水利工程有限公司

",

"createTime":"2015-05-15"},

{"id":"94a2432e24",

"title":"

市政府办公室关于表彰

2012 年度全市政府信息公开工作优秀单位的通报

",

"createTime":"2015-05-15"}]

8

第 8

页 共 13 页

v1.0

可编辑可修改

序号 节点标示 节点名称 数据类型

1

2

3

Id

Title

createTime

编号

标题

时间

String

String

String

2.2.4

失信公示详情查询

2.2.4.1

方法定义

曝光台 Webservice 接口及参数定义如下

:

数据类型

注释

查询指定的某条失信公示详情

序号

方法名

方法参数

1

querySHIXINDetail

Id

String

示例代码 (Java) : public String

querySHIXINDetail

(String id ) {/*todo*/}

2.2.4.2

返回数据

返回数据为字符串，内容格式为

json ，格式样板如下：

{"title":"

江苏省 2014 年 12 月份违法药品医疗器械保健食品广告公告

",

"content":"

各市、区人民政府，苏州工业园区、苏州高新区管委会；市各有关部门和单位：

，进一步建立健全政府信

2012

年，各地各部门认真贯彻《中华人民共和国政府信息公开条例》

息公开工作制度，深化公开内容，丰富公开载体，拓展公开范

围，不断提高政府信息公开的

及时性、完整性和实用性，较好地发挥了政府信息对人民群众生产、生活和经济社会活动的

服务作用。根据《市政府办公室关于开展

2012

年度全市政府信息公开工作考核的通知》

（苏

府办〔 2013〕14 号）精神，综合各地自查、平时检查、网上测评和实地调研考核等方面情况，

经市政府 同意，决定对昆山市人民政府办公室、苏州市发改委等政府信息公开工作优秀单位

予以通报表彰。各地各部门要以先进为榜样，进一步加强组织领导，完善工作机

制，强化制

度建设，加大公开力度，不断提升政府信息公开整体工作水平。

}

9

第 9

页 共 13 页

v1.0

可编辑可修改

序号 节点标示 节点名称 数据类型

1

2

Title

Content

标题

内容

String

String

2.3 企业名称查询接口定义

2.3.1 Webservice 方法定义

访问地址：

企业列表 Webservice 接口及参数定义如下

方法名

方法参数

:

注释

序号

1

enterpriseList

获取符合条件的企业列表，该方法为

模糊查询

示 例 代 码 (Java)

:

public

){/*todo*/}

String

enterpriseList

(

String

organCode,String

registerNum,String organName

2.3.2

请求参数

请求参数为下列数据。

序号 参数类型 参数 参数名称 注释

1

2

3

String

String

String

organCode

registerNum

organName

组织机构代码

工商注册号

企业名称

2.3.3

返回数据

返回数据为字符串，内容格式为

[{"id":"0","organName":"

{"id":"1","organName":"

JSON，格式样板如下：

企业名称 0"},

企业名称 1"}]

10

第 10

页 共 13 页

v1.0

可编辑可修改

序号 节点标示 节点名称 数据类型

1

2

id

organName

数据主键

String

String

企业名称

2.4 企业信息查询接口定义

2.4.1 Webservice 方法定义

访问地址：

企业信息 Webservice 接口及参数定义如下

方法名

方法参数

:

注释

序

号

1

enterpriseCreditInfo

获取企业的信用信息

String organId

示例代码 (Java) : public String enterpriseCreditInfo(

){/*todo*/}

2.4.2

请求参数

请求参数为下列数据。

序号

参数类型

参数

参数名称

注释

1

String

organId

企业 ID

2.4.3

返回数据

返回数据为字符串，内容格式为

JSON，格式样板如下：

[{

"baseInfo":{"organName":"

","scope":"

江苏华晨海洋工程服务有限公司

张家港保税区新世纪广场

","organCode":"590***347

机械设备租赁 ","address":"

306","registerNum":"3205*******8896","legalPerson":"

"tishiInfo":[{"checkResult":"

11

张三 "},

通过

第 11

页 共 13 页

v1.0

可编辑可修改

","year":"2000","checkTime":"2000-05-01","registerNum":"3205*******8896"},

{"checkResult":"

通过

","year":"2001","checkTime":"2001-05-01","registerNum":"3205*******8896"}],

"honorInfo":[{"identiDept":"

环保局 ","organCode":"1111111","identiTime":"2000"},

{"identiDept":"

环保局 ","organCode":"1111111"," identiTime ":"2001"}],

}]

baseInfo

中是基本信息

其中：

organName：企业名称

organCode ：组织机构代码

scope ：经营范围

address ：注册地址

registerNum

：工商注册号

legalPerson

：法定代表人

tishiInfo

中是提示信息

其中：

checkResult

：年检结论

year ：年检年度

checkTime ：（年检）核准日期

registerNum

：工商注册号

honorInfo

中是荣誉信息

其中：

12

第 12页 共 13页

13

第 13

页v1.0

可编辑可修改

共 13 页

identiDept

：认定机关名称

organCode ：组织机构代码

identiTime

：认定日期