接口调用说明文档doc.docx

接口调用说明文档doc.docx

《接口调用说明文档doc.docx》由会员分享，可在线阅读，更多相关《接口调用说明文档doc.docx（38页珍藏版）》请在冰豆网上搜索。

接口调用说明文档doc

v1.0可编辑可修改

XXXX科技有限公司

数据接口

2015-5-26

1第1页共13页

v1.0可编辑可修改

目

录

第1章引言..........................................................................................................................................................

3

1.1

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

3

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

4

2.1

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

4

2.1.1

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

4

2.1.2

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

5

2.2

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

6

2.2.1

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

6

2.2.2

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

7

2.2.3

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

8

2.2.4

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

9

2.3

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

10

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

10

2.3.2

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

10

2.3.3

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

10

2.4

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

11

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

11

2.4.2

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

11

2.4.3

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

11

2第2页共13页

v1.0可编辑可修改

第1章引言

1.1背景

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

档。

本接口通过Webservice方式进行交互，由市公共信用中心提供信息查询Webservice服务，供经

授权的调用使用。

3第3页共13页

v1.0可编辑可修改

第2章接口与数据定义

2.1曝光台查询接口

2.1.1曝光台列表查询

2.1.1.1方法定义

访问地址：

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

序号方法名方法参数数据类型注释

1queryBGTList空空查询曝光台列表信息（该方法默认返

回最新的50条数据）

示例代码（Java）:

publicStringqueryBGTList（）{/*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

Id

编号

String

2

Title

标题

String

3

createTime

时间

String

2.1.2曝光台详情查询

2.1.2.1方法定义

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

序号方法名方法参数数据类型注释

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

示例代码（Java）:

publicStringqueryBGTDetail（Stringid）{/*todo*/}

2.1.2.2返回数据

返回数据为字符串，内容格式为json，格式样板如下：

{"title":

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

"content":

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

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

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

予以公告。

"}

序号

节点标示

节点名称

数据类型

1

Title

标题

String

2

Content

内容

String

5第5页共13页

v1.0可编辑可修改

2.2信用公示查询接口定义

2.2.1守信公示列表查询

2.2.1.1方法定义

访问地址：

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

序号方法名方法参数数据类型注释

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

返回最新的50条数据）

示例代码（Java）:

publicStringquerySHOUXINList（）{/*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

Id

编号

String

2

Title

标题

String

6第6页共13页

v1.0可编辑可修改

3createTime时间String

2.2.2守信公示详情查询

2.2.2.1方法定义

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

序号方法名方法参数数据类型注释

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

示例代码（Java）:

publicStringquerySHOUXINDetail（Stringid）{/*todo*/}

2.2.2.2返回数据

返回数据为字符串，内容格式为json，格式样板如下：

{"title":

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

"content":

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

2012年，各地各部门认真贯彻《中华人民共和国政府信息公开条例》，进一步建立健全政府信

息公开工作制度，深化公开内容，丰富公开载体，拓展公开范围，不断提高政府信息公开的

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

服务作用。

根据《市政府办公室关于开展2012年度全市政府信息公开工作考核的通知》（苏

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

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

予以通报表彰。

各地各部门要以先进为榜样，进一步加强组织领导，完善工作机制，强化制

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

附件：

2012年度全市政府信息公开工作优秀单位"}

7第7页共13页

v1.0可编辑可修改

序号

节点标示

节点名称

数据类型

1

Title

标题

String

2

Content

内容

String

2.2.3失信公示列表查询

2.2.3.1方法定义

曝光台Webservice

接口及参数定义如下

:

序号

方法名

方法参数

数据类型

注释

1

querySHIXINList

空

空

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

最新的50条数据）

示例代码（Java）:

publicStringquerySHIXINList（）{/*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

Id

编号

String

2

Title

标题

String

3

createTime

时间

String

2.2.4失信公示详情查询

2.2.4.1方法定义

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

序号方法名方法参数数据类型注释

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

示例代码（Java）:

publicStringquerySHIXINDetail（Stringid）{/*todo*/}

2.2.4.2返回数据

返回数据为字符串，内容格式为json，格式样板如下：

{"title":

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

"content":

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

2012年，各地各部门认真贯彻《中华人民共和国政府信息公开条例》，进一步建立健全政府信

息公开工作制度，深化公开内容，丰富公开载体，拓展公开范围，不断提高政府信息公开的

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

服务作用。

根据《市政府办公室关于开展2012年度全市政府信息公开工作考核的通知》（苏

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

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

予以通报表彰。

各地各部门要以先进为榜样，进一步加强组织领导，完善工作机制，强化制

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

}

9第9页共13页

v1.0可编辑可修改

序号

节点标示

节点名称

数据类型

1

Title

标题

String

2

Content

内容

String

2.3企业名称查询接口定义

2.3.1Webservice方法定义

访问地址：

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

序号方法名方法参数注释

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

模糊查询

示例代码（Java）:

publicStringenterpriseList（StringorganCode,String

registerNum,StringorganName）{/*todo*/}

2.3.2请求参数

请求参数为下列数据。

序号

参数类型

参数

参数名称

注释

1

String

organCode

组织机构代码

2

String

registerNum

工商注册号

3

String

organName

企业名称

2.3.3返回数据

返回数据为字符串，内容格式为JSON，格式样板如下：

[{"id":

"0","organName":

"企业名称0"},

{"id":

"1","organName":

"企业名称1"}]

10第10页共13页

v1.0可编辑可修改

序号

节点标示

节点名称

数据类型

1

id

数据主键

String

2

organName

企业名称

String

2.4企业信息查询接口定义

2.4.1Webservice方法定义

访问地址：

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

序方法名方法参数注释

号

1enterpriseCreditInfo获取企业的信用信息

示例代码（Java）:

publicStringenterpriseCreditInfo（StringorganId）{/*todo*/}

2.4.2请求参数

请求参数为下列数据。

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

1StringorganId企业ID

2.4.3返回数据

返回数据为字符串，内容格式为JSON，格式样板如下：

[{

"baseInfo":

{"organName":

"江苏华晨海洋工程服务有限公司","organCode":

"590***347

","scope":

"机械设备租赁","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页

v1.0可编辑可修改

identiDept：

认定机关名称

organCode：

组织机构代码

identiTime：

认定日期

13第13页共13页