接口调用说明文档
WebAPI接口说明文档
WebAPI接⼝说明⽂档1.采⽤ Web API Help Page 显⽰效果
2.swaggerui 创建⽂档接⼝效果图
3.swagger ui 安装配置
nuget 安装
2.设置xml⽂件
3.配置根路径
对接口文档的理解-概述说明以及解释
对接口文档的理解-概述说明以及解释
1.引言
1.1 概述
接口文档是在软件开发过程中，对于软件系统中接口进行描述和说明的文档。它记录了各个接口的功能、输入输出参数、调用方式以及其他相关信息，为软件开发人员、测试人员和其他相关人员提供了明确的接口定义和使用方法。接口文档可以视为软件系统与外部系统、模块之间的沟通桥梁，是保证软件系统准确交互的重要依据。
在软件开发领域中，接口是软件模块之间进行交互的方式。一个好的接口文档能够明确规定接口的功能和使用方式，从而确保不同的模块能够正确地协同工作。接口文档通过提供详细的接口说明，使得开发人员能够了解每个接口的具体作用和参数要求，从而保证开发的软件能够按照预期的方式与其他系统进行沟通和交互。
在软件开发过程中，接口文档起到了桥梁的作用，连接了不同开发人员之间的沟通。通过接口文档,软件开发人员可以明确了解其他模块或外部系统提供的接口规范和数据格式，从而能够更好地进行接口的集成和调用。在团队合作中，接口文档也帮助开发人员更好地理解其他人开发的模块，减少了在开发过程中因为不一致的接口定义所带来的协调问题。
总结来说，接口文档在软件开发过程中具有重要的作用。它能够明确接口的功能和使用方式，提供清晰的接口定义，使得软件系统能够准确无误地与外部系统进行交互。同时，接口文档也帮助团队成员更好地协同工作，提高开发效率。因此，编写准确、清晰的接口文档是软件开发过程中不可忽视的一环。
在文章结构部分，我们将详细介绍这篇长文的组成和章节内容安排。
本文主要包括引言、正文和结论三个部分。
接口规范文档
接口规范文档
1. 简介。
接口规范文档是软件开发过程中非常重要的一环，它定义了软件系统中各个模块之间的通信方式和数据交换格式。一个好的接口规范文档可以有效地提高开发效率，降低沟通成本，减少后期的修改和维护工作。
2. 目的。
接口规范文档的主要目的是明确规定软件系统中各个模块之间的通信方式和数据交换格式，以便于开发人员能够按照统一的规范进行开发工作。同时，接口规范文档也可以作为开发人员和测试人员之间沟通的桥梁，减少因为接口不清晰而导致的开发和测试工作的偏差。
3. 内容。
接口规范文档通常包括以下内容：
接口描述，对接口的功能和作用进行详细的描述，包括输入参数、输出参数、返回值等。
接口格式，定义接口的数据交换格式，如JSON、XML等。
接口调用方式，明确规定接口的调用方式，包括请求方法、URL、参数传递方式等。
接口安全性，定义接口的安全机制，包括认证、授权、加密等。
接口错误处理，规定接口返回错误码和错误信息的格式和含义。
接口版本管理，定义接口的版本管理策略，包括版本号的规范和升级方式。
4. 编写规范。
接口规范文档的编写应当遵循一定的规范，以便于开发人员和测试人员能够快
速地理解和使用。具体规范包括：
使用简洁明了的语言描述接口的功能和作用，避免使用过于复杂的术语和词汇。
使用统一的格式和风格，包括文档的结构、标题、字体、颜色等。
为每个接口添加详细的注释，包括参数的含义、取值范围、示例等。
定期更新和维护接口规范文档，及时反映系统的变化和需求的变更。
5. 实例。
以下是一个简单的接口规范文档的实例：
接口名称，用户登录接口。
接口文档的内容
接口文档的内容
修订历史
2、用户认证接口API
2.1请求消息体：
链接地址
链接地址
注：sign由channelId+key+timestamp+phone生成的字符串MD5加密生成，编码使用UTF-8。key为权益中心提供给渠道方系统的一串需保密(不能向第三方透露)的字符串，请渠道方系统妥善保管。
2.2响应消息体：
{报文示例} 2.3错误码：
2.4业务交互流程：
详细交互流程：
1、用户在点击进入活动入口后，由渠道方服务端发起用户认证接口调用
2、中间账户平台收到服务端接口消息后，为用户分配token，并在接口响应中返回。
3、渠道方收到token后，在活动入口页面，加上token，结果：链接地址?token=XXX。
渠道方app引导app内用户页面访问：
链接地址?token=后面拼接接口获取到的token
4、中间账户平台在收到请求后，解析token，如果token有效或者存在，则直接展
示活动页面，否则将显示文本框输入界面
5、成功获取信息后，则自动登录注册成功，用户可以进行活动领取
6、url不携带token，无法获得用户信息，则不给用户展示页面
SDK通用版接口调用说明
SDK通用版接口调用说明
目录
1请仔细阅读信息安全责任保证条款 (2)
1.1安全信息责任条款 (2)
1.2注意事项：................................................................................. 错误！未定义书签。
1 Webservice接口 (3)
1.1 webservice返回集合对照表 (3)
2、多线程webservice接口 (5)
2.1 mdgxsend 个性短信 (5)
3、多线程http接口 (8)
3.1 多线程群发普通短信 (8)
3.2 多线程群发个性短信 (9)
请仔细阅读信息安全责任保证条款
安全信息责任条款
本人/本公司在使用本软件过程中，将严格遵守国家相关法律、法规、保证本公司信息发布的安全，并切实做到：
（1）建立健全本公司信息发布的内部保障制度、信息安全保密制度、用户信息安全管理制度，建立健全本公司信息安全责任制度和信息发布的审批制度，严
格审查本公司产品所发布信息。
（2）严格遵守《互联网信息服务管理办法》，对用户编辑的信息内容进行把关，保证信息内容的健康、合法。
（3）明确本企业的客户群和客户范围，所有通讯受众必须是自愿且明确同意接受企业服务。
（4）若发送未经用户允许的信息等所造成的影响、投诉等一切损失与本软件版权方无关、由本人/本公司承担全部责任；同时，本人/本公司也应承担若因此
给本软件版权方造成的全部损失。
（5）不利用本软件制作、复制、发布、传播含有下列内容的信息：
反对宪法所确定的基本原则的；
接口调用协议
接口调用协议
接口调用协议
一、前言
本协议旨在规范接口调用的流程和方式，确保系统之间的通信顺畅、
安全可靠。所有使用本系统的开发人员必须遵守本协议。
二、定义
1. 接口：在一个系统中向外提供服务或数据的方法或函数。
2. 调用：通过接口请求服务或数据的过程。
3. API（Application Programming Interface）：应用程序编程接口，是一种软件组件，用于不同软件之间进行交互和通信。
三、协议内容
1. 接口定义
1.1 接口名称：每个接口应该有一个唯一的名称，以便于其他系统进行调用。
1.2 接口说明：应该对接口进行详细的说明，包括输入参数、输出参数、返回值等信息。
1.3 接口版本号：每个接口应该有一个版本号，以便于对不同版本进行管理和维护。
2. 接口调用方式
2.1 HTTP/HTTPS方式：使用HTTP/HTTPS协议进行数据传输，在URL中指定API名称和参数，并通过HTTP请求方法（GET/POST）
来实现对API的调用。
2.2 Socket方式：使用Socket套接字实现客户端与服务器之间的通信。客户端通过Socket连接服务器，并发送请求消息给服务器。服务器收到请求消息后处理并返回响应消息给客户端。
3. 接口调用流程
3.1 客户端向服务器发送请求消息，包括API名称和参数。
3.2 服务器接收到请求消息后，进行参数验证和权限验证。如果验证通过，则执行相应的业务逻辑，并返回响应消息给客户端。
3.3 客户端收到响应消息后，对响应结果进行解析和处理。
4. 接口安全
4.1 接口鉴权：在接口调用前，需要对调用方进行身份认证和授权。可以使用Token或API Key等方式来实现接口鉴权。
数据服务接口调用文档_V1.0
SDCwebservice第三方应用配置接口调用说
明文档
数据查询服务
根据工号查询教师基本信息
identity:授权序列号。
serviceName：数据查询服务对应的服务编码。
params：输入参数，json格式,[{"value":"?","key":"GH"}]，key指的是工号。t：随机数，消除浏览器缓存影响。
http://服务器地址:8080/SDCenter2.0/ws/wsDataService/queryService?t=Math.random()& identity=参数&serviceName=参数¶ms=参数
根据考生号查询研究生入学信息
identity:授权序列号。
serviceName：数据查询服务对应的服务编码。
Params：输入参数，json格式,[{"value":"?","key":"KSH"}]，key指的是考生号。
t：随机数，消除浏览器缓存影响。
http://服务器地址:8080/SDCenter2.0/ws/wsDataService/queryService?t=Math.random()& identity=参数&serviceName=参数¶ms=参数
根据课程属性码查询计划学分学时信息
identity:授权序列号。
serviceName：数据查询服务对应的服务编码。
Params：输入参数，json格式,[{"value":"?","key":"KCSXM"}]，key指的是课程属性码。
t：随机数，消除浏览器缓存影响。
http://服务器地址:8080/SDCenter2.0/ws/wsDataService/queryService?t=Math.random()& identity=参数&serviceName=参数¶ms=参数
postman快速生成接口说明文档的方法-概述说明以及解释
postman快速生成接口说明文档的方法-概述说明以
及解释
1.引言
1.1 概述
概述部分的内容可以简要介绍文章要讨论的主题和内容，并对接下来的章节进行提要。对于这篇文章来说，可以写以下内容：
在软件开发的过程中，接口说明文档是非常重要的一部分。它用于记录系统的接口信息，包括接口的功能、参数、返回值等，方便开发者之间的沟通和协作。然而，传统的编写接口说明文档的方式通常比较繁琐，容易出现文档与实际接口不一致的情况。
Postman是一款功能强大的接口测试工具，它不仅可以用于发送请求、查看响应结果，还可以帮助开发者快速生成接口说明文档。本文将介绍如何利用Postman来快速生成接口说明文档的方法，旨在帮助开发者提高工作效率，减少文档编写的工作量。
接下来，我们将从Postman的简介开始，介绍其主要功能和使用方式。接着，我们会探讨接口说明文档的重要性，以及为什么使用Postman 来生成文档能够提高开发效率。最后，我们将详细介绍Postman快速生成接口说明文档的方法，包括如何导入接口、添加接口描述、参数设置等
步骤。
通过阅读本文，读者将了解到如何利用Postman这一强大工具来快速生成接口说明文档，从而提升开发效率，并减少文档编写的工作负担。接下来的章节将深入介绍Postman的功能和使用方法，以及如何利用它来生成接口说明文档。
文章结构部分是要对整篇文章的框架进行介绍，它可以包括以下内容：
1.2 文章结构
本文主要分为引言、正文和结论三个部分。
在引言部分，我们首先对本篇文章的背景和概述进行了介绍，然后阐述了文章的整体结构和目的。
接口调用范例
第一部分接口调用规范
1.1 接口访问地址（）
外挂系统请求服务的接口访问地址：
待定
其中IP标识Web服务器地址；port对应系统应用服务的端口号，启用80的不填写。
1.2 接口调用函数
外挂系统请求服务平台的接口包括两类：查询类和写入类接口。查询类接口对外提供查询服务，写入类接口对外提供将业务数据写入综合应用平台业务库。
1.2.1 查询类接口
public StringqueryObjectOut(Stringxtlb,String jkxlh,String jkid,String QueryXmlDoc);
1.2.2 写入类接口
Public String writeObjectOut (String xtlb,String
jkxlh,String jkid;String WriteXmlDoc)
1.3 XML文件格式定义
1.3.1 查询类接口XML文档
查询条件QueryXmlDoc的文档格式要求如下：
查询返回结果XML文档格式
1.3.2 写入类接口XML文档
写入数据WriteXmlDoc文档格式如下：
写入操作返回结果文档格式如下：
1.4 调用注意事项
1.4.1 XML文档的中文处理
（1）接口查询结果进行过URLDecoder和UTF-8编码处理,须进行转换（转换函数为URLDecoder.decode(str, "utf-8");）才能正常读取；
（2）写入信息中文字符必须URLEncoder成utf-8格式（转换函数为URLEncoder.encode(xmlDoc, "utf-8")；）后再封装成XML文档。
接口文档范例示意
接口文档范例示意
文章标题：接口文档范例示意 - 简单易懂的API文档设计与编写
引言：
在软件开发过程中，为了实现不同系统之间的互联互通，接口文档的编写变得尤为重要。好的接口文档不仅能够提供清晰的指导，还能减少开发者之间的沟通成本，提高开发效率。本文将以一个示意的接口文档范例为例，探讨如何编写一份简单易懂的API文档。
第一部分：接口概述
1.1 接口名称和版本信息
在接口概述中，首先需要明确接口的名称和版本信息。例如：
接口名称：用户管理接口
版本号：v1.0
1.2 接口描述
在接口描述中，应该简要说明该接口的作用和功能。例如：
该接口用于对系统中的用户进行管理，包括用户的创建、查询、更新和删除等操作。
1.3 接口区域信息和请求方式
在接口区域信息和请求方式中，需要提供接口的URL区域信息以及HTTP请求的方式。例如：
接口区域信息：/api/users
请求方式：GET
第二部分：请求参数
2.1 公共请求参数
公共请求参数是指在每个接口中都需要使用的参数，例如身份认证信息、时间戳等。在该部分中，列举出每个公共请求参数的名称、类型和是否必填。例如：
- access_token（字符串，必填）：用于身份认证的令牌。
- timestamp（字符串，必填）：请求的时间戳。
2.2 接口请求参数
接口请求参数是指该接口所需的具体参数，包括请求方法（GET、POST等），请求体中的参数以及可选的路由参数等。在该部分中，详细描述每个请求参数的名称、类型、是否必填、描述以及示例值。例如：
- name（字符串，必填）：用户姓名。
API接口文档(精简版)
API接口文档(精简版)
API接口文档（精简版）
1. 简介
该文档提供了有关API接口的详细信息，包括接口功能、请求参数、返回结果等内容。开发人员可以通过此文档了解如何正确调用API接口，并获取所需的数据或实现特定功能。
2. 接口列表
以下是可用的API接口列表：
- 接口1：功能描述1接口1：功能描述1
- 接口2：功能描述2接口2：功能描述2
- 接口3：功能描述3接口3：功能描述3
3. 接口1
该接口实现了功能描述1。以下是该接口的详细信息。
3.1 请求URL
GET /api/interface1
3.2 请求参数
该接口不需要任何请求参数。
3.3 返回结果
该接口返回以下结果。
{
"result": "success",
"message": "接口调用成功",
"data": {
"field1": "value1",
"field2": "value2"
}
}
4. 接口2
该接口实现了功能描述2。以下是该接口的详细信息。
4.1 请求URL
POST /api/interface2
4.2 请求参数
该接口需要以下请求参数。
4.3 返回结果
该接口返回以下结果。
{
"result": "success", "message": "接口调用成功", "data": {
"field1": "value1",
"field2": "value2"
}
}
5. 接口3
该接口实现了功能描述3。以下是该接口的详细信息。
5.1 请求URL
PUT /api/interface3/{id}
5.2 请求参数
该接口需要以下请求参数。
5.3 返回结果
接口文档范文
接口文档范文
1. 引言
接口文档是软件开发中非常重要的一部分，它定义了系统与外部系统或组件之间的通信接口。本文档旨在提供一个接口文档范文，以便开发人员编写规范的接口文档，确保系统能够与其他系统或组件正确地交互。
2. 接口概述
本接口文档描述了一个名为“示例系统”的接口规范。该系统提供了一组RESTful API，用于管理用户信息。通过这些接口，可以进行用户的创建、读取、更新和删
除操作。
2.1 接口基本信息
•接口名称：用户管理接口
•接口版本：1.0.0
•接口地址：``
2.2 接口认证
本接口要求进行身份认证，使用OAuth 2.0协议进行授权。在每个请求中，需要在请求头中添加Authorization字段，其值为Bearer ，access_token
需要通过授权服务器获取。
3. 接口详细说明
3.1 获取用户列表
•接口路径：GET /users
•接口描述：获取所有用户的列表信息
•请求参数：无
•响应参数：
–id：用户ID（整数）
–name：用户姓名（字符串）
–email：用户邮箱（字符串）
–created_at：用户创建时间（字符串，格式为YYYY-MM-DD HH:MM:SS）•响应示例：
[
{
"id": 1,
"name": "John Doe",
"email":"****************",
"created_at": "2021-01-01 10:00:00"
},
{
"id": 2,
"name": "Jane Smith",
"email":"****************",
"created_at": "2021-01-02 11:00:00"
api接口文档模板
api接口文档模板
一、概述
API接口文档是软件开发过程中不可或缺的一部分，它扮演着向用户、开发者传达软件开发进度、设计思路和接口规范等信息的重要作用。接口文档能够使得开发人员更快更准确地了解如何与软件程序进行交互，保证软件交互的可靠性和通用性，因此在软件开发过程中接口文档不可忽视。
二、文档要求
1. 目的：该文档主旨在提供一套承载软件开发工程中的API接口标准和规范，方便开发工程师更快更准确地完成开发工作。
2. 适用人群：该文档适用于所有开发工程师，包括开发人员、测试人员、架构师等。
3. 范围：该文档涵盖了API接口的规范及其对应格式，包括接口URL，请求方式，请求参数，响应格式等。
三、API接口文档模板
接口名称：xxxxxx
接口地址：xxxxxx
请求方式：xxxxxx
接口描述：xxxxxx
请求参数：
参数名类型是否必须说明userId int 是用户ID userName string 是用户名userAge int 否用户年龄
响应参数：
参数名类型说明
code int 返回状态码
msg string 返回信息
data array 返回数据数组
返回示例：
{
"code": 200,
"msg": "success",
"data": [
{
"userId": 1,
"userName": "Tom", "userAge": 20
},
{
"userId": 2,
"userName": "Jerry", "userAge": 30
}
]
}
四、注意事项
1. 接口名称应清晰、易懂；
2. 接口地址需正确、完整；
java项目的接口说明
java项目的接口说明
接口说明是为了帮助开发人员理解和使用一个 Java 项目中的接口。接口是一个抽象构造，用于定义类之间的通信协议。一个接口可以包含多个方法声明，但没有方法的实现。在这篇文档中，我们将讨论如何编写一个清晰、易读和易于理解的接口说明。
在撰写接口说明时，应遵循一些最佳实践，以确保文档的易读性和清晰度。以下是一个示例接口说明的框架，可作为参考：
1. 接口概述：
- 描述接口的目的和功能。
- 说明接口如何被用于项目中的其他类。
2. 接口方法：
- 罗列出接口中定义的所有方法。
- 对每个方法进行简要说明，包括方法的目的、输入参数和返回值。
3. 使用示例：
- 提供一个简单的代码示例，展示如何使用接口。
- 解释每个示例代码行的作用和效果。
4. 实现建议：
- 对于使用接口的开发人员，提供一些建议和最佳实践。
- 解释如何正确实现接口方法，并提供示例代码。
5. 注意事项：
- 提供使用接口时需要注意的一些问题和限制。
- 解释如何处理接口的变化和更新。
6. 参考资料：
- 列出相关的参考资料、文档或类似的项目。
以下是一些编写接口说明的参考内容：
1. 接口名称和目的：明确接口的名称，并简要描述其目的和功能。
2. 方法声明和说明：按照规范格式，提供每个方法的声明和说明，包括输入参数和返回值。
3. 代码示例：提供简单易懂的代码示例，展示接口如何在实际项目中使用。
4. 方法实现建议：为实现接口的开发人员提供一些建议，并给出示例代码。
5. 异常处理：说明接口方法可能抛出的异常，并提供相应的处理建议。
6. 使用限制和注意事项：描述使用接口时的一些限制和注意事项，例如线程安全性、性能影响等。
api接口文档模板
api接口文档模板
API接口文档模板。
一、接口概述。
API（Application Programming Interface）即应用程序接口，是软件系统中不同程序之间交换数据的约定。API接口文档是对接口的详细说明，包括接口的功能、参数、返回结果等信息，供开发者使用和参考。本文档旨在提供一个标准的API 接口文档模板，帮助开发者规范接口文档的编写。
二、接口信息。
1. 接口名称，。
2. 接口地址，。
3. 请求方法，。
4. 接口版本，。
5. 接口作者，。
6. 更新时间，。
三、接口功能。
（这部分需详细描述接口的功能和作用）。
四、请求参数。
1. 参数名称，。
参数类型，。
是否必填，。
2. 参数名称，。
参数类型，。
是否必填，。
参数说明，。
（依此类推，根据实际接口参数进行详细描述）。
五、返回结果。
1. 返回字段，。
字段类型，。
字段说明，。
2. 返回字段，。
字段类型，。
字段说明，。
（根据实际返回结果进行详细描述）。
六、错误码。
1. 错误码，。
错误信息，。
解决方案，。
2. 错误码，。
解决方案，。
（根据实际接口可能出现的错误码进行详细描述）。
七、示例。
请求示例：
```。
{。
"参数1": "数值1",。
"参数2": "数值2"
}。
```。
返回示例：
```。
{。
"字段1": "数值1",。
"字段2": "数值2"
}。
```。
八、接口权限。
（如果接口需要权限验证，需在此部分进行详细描述）。
九、其他注意事项。
（这部分可包括接口的调用频率限制、安全注意事项等）。
以上就是一个标准的API接口文档模板，希望开发者在编写接口文档时能够按照该模板进行规范化的操作，以便更好地进行接口的使用和维护。同时，也希望在实际使用中能够不断完善和优化该模板，使其更符合实际需求。
项目接口需求及设计说明文档模板
项目接口需求及设计说明文档模板
一、引言
这个模板旨在提供一个规范和结构化的方式来描述项目的接口需求
和设计说明。该文档的目的是帮助项目团队更好地理解接口需求，并
提供设计说明来满足这些需求。
二、接口需求
在这一部分，我们将详细描述项目的接口需求。每个接口需求都应
该包括以下内容：
1. 接口标识符：每个接口都应该有一个唯一的标识符，以便于项目
团队进行识别和引用。
2. 接口描述：对每个接口进行详细的描述，包括其功能和预期的输
入输出。
3. 接口类型：清楚地指明接口的类型，比如数据接口、服务接口等。
4. 接口依赖：如果接口依赖其他接口或外部系统，需要明确指出依
赖关系。
5. 安全性要求：如果接口需要进行身份验证或授权等安全性要求，
应在此说明。
6. 通信协议：如果接口需要使用特定的通信协议，应在此指明。
三、接口设计说明
在这一部分，我们将提供接口的设计说明，以满足项目的需求。
1. 接口命名约定：为了保持一致性和易于理解，我们将定义一套接
口命名约定，以便开发人员能够轻松理解和使用这些接口。
2. 接口参数：对于每个接口，我们将详细列出其输入和输出参数，
包括参数的类型、名称、默认值和描述。
3. 数据格式：如果接口涉及到数据传输，我们将定义数据的格式，
包括数据的结构、字段名称、字段类型和字段描述。
4. 接口响应：对于每个接口，我们将明确定义其响应的格式和内容，以便开发人员能够正确解析和处理接口的返回结果。
5. 错误处理：我们将描述不同的错误码和错误信息，并指导开发人
员处理不同的错误情况。
6. 接口文档：接口设计说明文档的最后，我们将提供一个接口文档
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
XXX）科技有限公司
数据接口
2015-5-26
目录
第1章引言. ......................................................... 错误!未定义书签。
背景. ........................................................... 错误!未定义书签。
第2章接口与数据定义. ................................................... 错误!未定义书签。
曝光台查询接口. ..................................................... 错误!未定义书签。
曝光台列表查询.......................... 错误!未定义书签。
曝光台详情查询.......................... 错误!未定义书签。
信用公示查询接口定义.......................... 错误!未定义书签。
守信公示列表查询.......................... 错误! 未定义书签。
守信公示详情查询.......................... 错误!未定义书签。
失信公示列表查询.......................... 错误!未定义书签。
失信公示详情查询.......................... 错误!未定义书签。
企业名称查询接口定义.......................... 错误!未定义书签。
Webservice 方法定义 ........................ 错误! 未定义书签。
请求参数. .................................................... 错误! 未定义书签。
返回数据. .................................................... 错误!未定义书签。
企业信息查询接口定义.......................... 错误!未定义书签。
Webservice 方法定义 ........................ 错误! 未定义书签。
请求参数. .................................................... 错误! 未定义书签。
返回数据. .................................................... 错误!未定义书签。
第1章引言
1.1 背景
为进一步保证业务的正确性及数据的安全统一性，并为后续各方开发工作提供指导，特编写此文档。
本接口通过Webservice 方式进行交互，由市公共信用中心提供信息查询Webservice 服务，供经授权的调用使用。
第2章接口与数据定义
2.1曝光台查询接口
2.1.1曝光台列表查询
2.1.1.1 方法定义
访问地址：
示例代码（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月份违法药品医疗器械保健食品广告公告",
"createTime":"2015-05-15"}]
2.1.2 曝光台详情查询
2.121 方法定义
示例代码（Java） : public String queryBGTDetail （String id ） {/*todo*/}
2.1.2.2返回数据
返回数据为字符串，内容格式为json，格式样板如下：
{"title":" 江苏省2014年12月份违法药品医疗器械保健食品广告公告",
"con te nt":"根据《江苏省药品监督管理条例》第三十二条的规定，我局经研究决定，自
2015年2月15日起，对标示为吉林通化百信药业有限公司利肺胶囊等2种违法广告药品（品种名单见附件）采取暂停销售措施，在我省范围内暂停上述2品种的销售，现予以公告。"}
2.2信用公示查询接口定义
2.2.1守信公示列表查询
2.2.1.1 方法定义
示例代码（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"}]