门户接口描述文档
接口文档样例模板
接口文档样例模板一、接口概述：本文档是针对XXX系统的接口文档，用于说明系统提供的各种接口的具体功能和使用方法。
二、接口列表：1.接口名称：用户登录接口请求方式：POST接口描述：用户使用用户名和密码进行登录验证，返回登录状态和用户信息。
请求参数：- username(string，必填)：用户输入的用户名。
- password(string，必填)：用户输入的密码。
返回参数：- status(string)：登录状态，值为"success"或"fail"。
- message(string)：登录状态描述信息。
- user_info(object)：用户信息，包括用户ID、昵称等。
请求示例：```json"username": "admin",}```返回示例：```json"status": "success","message": "登录成功","user_info":"user_id": 1,"nickname": "管理员"}}```2.接口名称：获取用户列表接口请求方式：GET接口描述：获取系统中所有用户的列表。
请求参数：无返回参数：- status(string)：获取状态，值为"success"或"fail"。
- message(string)：获取状态描述信息。
- user_list(array)：用户列表，包括用户ID、昵称等。
请求示例：无返回示例：```json"status": "success","message": "获取成功","user_list":"user_id": 1,"nickname": "管理员"},"user_id": 2,"nickname": "用户1"}}```三、接口调用说明：2. 接口调用前需确保用户已经获取到相应的access token，并将其作为请求头中的Authorization字段进行传递。
对接口文档的理解-概述说明以及解释
对接口文档的理解-概述说明以及解释1.引言1.1 概述接口文档是在软件开发过程中，对于软件系统中接口进行描述和说明的文档。
它记录了各个接口的功能、输入输出参数、调用方式以及其他相关信息，为软件开发人员、测试人员和其他相关人员提供了明确的接口定义和使用方法。
接口文档可以视为软件系统与外部系统、模块之间的沟通桥梁，是保证软件系统准确交互的重要依据。
在软件开发领域中，接口是软件模块之间进行交互的方式。
一个好的接口文档能够明确规定接口的功能和使用方式，从而确保不同的模块能够正确地协同工作。
接口文档通过提供详细的接口说明，使得开发人员能够了解每个接口的具体作用和参数要求，从而保证开发的软件能够按照预期的方式与其他系统进行沟通和交互。
在软件开发过程中，接口文档起到了桥梁的作用，连接了不同开发人员之间的沟通。
通过接口文档,软件开发人员可以明确了解其他模块或外部系统提供的接口规范和数据格式，从而能够更好地进行接口的集成和调用。
在团队合作中，接口文档也帮助开发人员更好地理解其他人开发的模块，减少了在开发过程中因为不一致的接口定义所带来的协调问题。
总结来说，接口文档在软件开发过程中具有重要的作用。
它能够明确接口的功能和使用方式，提供清晰的接口定义，使得软件系统能够准确无误地与外部系统进行交互。
同时，接口文档也帮助团队成员更好地协同工作，提高开发效率。
因此，编写准确、清晰的接口文档是软件开发过程中不可忽视的一环。
在文章结构部分，我们将详细介绍这篇长文的组成和章节内容安排。
本文主要包括引言、正文和结论三个部分。
1. 引言部分：1.1 概述：简要介绍本文要讨论的主题，即对接口文档的理解。
1.2 文章结构：介绍文章的整体结构，包括各个章节的内容和目的。
1.3 目的：明确文章的写作目的和意义。
2. 正文部分：2.1 接口文档的定义：详细解释什么是接口文档，以及它的基本概念和特点。
2.2 接口文档的作用：探讨接口文档在软件开发中的重要作用，如改善沟通效率、规范接口设计等方面。
接口需求说明书
接口需求说明书
XXX有限公司
2019年5月
版本历史记录
一、引言
本章分为以下几条。
标识
本文档适用于XXXX管理系统，用于XXXX项目。
功能概述
项目为XXXX对接接口开发。
项目由XXX直接出资建设，用于XXXX数据信息扩展，获取XXXX业务数据。
文档概述
为明确软件需求、安排项目规划与进度、组织软件开发、测试与验收，撰写本文档。
预期读者
项目经理、开发人员、测试人员、客户等。
二、需求说明
为实现XXX管理系统获取XXX业务数据进行开发，所需数据包括6个分类:
1、xxx~6、xxxxo
该部分信息由XXX的功能，进行新旧数据的推送。
我方开发接口，接收XXX^ XXX、XXX等参数。
系统关联图
其他功能需求
通过接口获取的数据，应约束数据写入范围。
仅提供约定范围的栏目数据写
Ao。
完整word版,接口文档模板1.0
完整word版,接口文档模板1.0完整word版接口文档模板1.0.0接口文档模板1. 引言本文档旨在提供一个标准的接口文档模板，用于描述系统内部或与外部系统之间的接口规范。
通过遵循本模板，可以准确地描述接口的请求和响应参数，以及接口的使用方法、返回码定义等相关内容。
2. 接口信息- 接口名称：[接口名称]- 接口版本：1.0.0- 接口地址：[接口地址]- 请求方法：[请求方法]- 返回格式：JSON- 授权方式：[授权方式] 3. 接口描述[接口描述]4. 请求参数4.1 公共参数无4.2 请求参数5. 响应参数5.1 公共参数无5.2 响应参数6. 接口示例6.1 请求示例import requestsheaders = {'Content-Type': 'application/json'} data = {"param1": "value1","param2": 123}response = requests.post(url, headers=headers, data=json.dumps(data))print(response.json())6.2 响应示例{"code": 200,"message": "请求成功","data": {"result": "success"}}7. 返回码定义8. 接口权限控制无9. 参考资料无以上是一个标准的接口文档模板，通过填写相关信息，可以准确地描述一个接口的规范和用法。
根据实际情况，可以对文档的结构和内容进行适当调整和扩展。
希望这个模板对您有所帮助！如果需要进一步的协助，请随时告诉我。
对外接口需求(精品文档)_共1页
3对外接口需求
3.1用户界面
界面风格：本系统采用的是图形用户界面，借书人员的界面与管理人员的界面是不同的，借书人的界面总体色调偏白色，给人感觉较为稳重因为借阅书籍是一项文艺的事情，工作人员的界面则偏向于灰色，界面简单但合理搭配。
界面布局：系统页面较为合理，给人一种成熟稳重的感觉
界面操作：页面上的每一个按钮、文本框等都是经过设计人员精心设计目的就是为了用户使用系统更加方便快捷。
界面内容：所有界面设置导航，并且规定消息的显示为弹出式显示。
3.2硬件接口
支持硬件类型：
软硬件之间交流的数据和控制信息的性质：借书人账户上借阅的所有书籍并且显示以往借阅过的书籍等等
通信协议：HTTP协议
3.3软件接口
数据库：本系统采用MYSQL数据库进行开发
操作系统：开发系统为Windows Server 2012
工具：Myeclipse2013、tomcat等等
软件之间交换是数据的目的：达到信息同步的效果
其他服务：暂无
3.4 通信接口
该产品可用web进行浏览。
本文档下载后根据实际情况可编辑修改使用。
webservice接口文档
WebService接口文档文档版本号：v9.9.5更新时间：2016年09月28日重要说明本人/本公司在使用本软件过程中，将严格遵守国家相关法律、法规、保证本公司信息发布的安全，并切实做到：（1）建立健全本公司信息发布的内部保障制度、信息安全保密制度、用户信息安全管理制度，建立健全本公司信息安全责任制度和信息发布的审批制度，严格审查本公司产品所发布信息。
（2）严格遵守《互联网信息服务管理办法》，对用户编辑的信息内容进行把关，保证信息内容的健康、合法。
（3）明确本企业的客户群和客户范围，所有通讯受众必须是自愿且明确同意接受企业服务。
（4）若发送未经用户允许的信息等所造成的影响、投诉等一切损失与本软件版权方无关、由本人/本公司承担全部责任；同时，本人/本公司也应承担若因此给本软件版权方造成的全部损失。
（5）不利用本软件制作、复制、发布、传播含有下列内容的信息：✧反对宪法所确定的基本原则的；✧危害国家安全，泄露国家秘密，颠覆国家政权，破坏国家统一的；✧损坏国家荣誉和利益的；✧煽动民族仇恨、民族歧视，破坏民族团结的；✧破坏国家民族宗教政策，宣扬邪教和封建迷信的；✧散布谣言，扰乱社会秩序，破坏社会稳定的；✧散布淫秽、色情、赌博、暴力、凶杀、恐怖或者教唆犯罪的；✧侮辱或者诽谤他人，侵害他人合法权益的；✧含有法律、行政法规禁止的其他内容的；（6）自信息发布六个月内不修改删除信息发送日志内容，日志记录的备份应至少保持6个月以上，在国家机关进行依法查询时，予以提供。
（7）若发现本公司所发布的信息明显属于上述第（5）款所列内容，保证立即停止传输，并向国家有关机关报告。
（8）对本公司所发布的信息一时难以辨别是否属于以上所列内容之一的，应报相关主管部门审核同意后再发布。
（9）对客户的个人信息保密，未经客户同意不得向他人泄漏，但法律规定的除外。
本人/本公司保证：在使用本软件进行信息发布活动中，服从监督和管理；若未做到上述一至八条，本人/本公司愿意承担由此引起的一切法律责任，并接受相应的处罚。
接口文档(范例)
接口详细设计文档 (1)1 编写目的 (4)2 名词解释 (4)3组件分布图 (5)4 程序结构 (6)4.1 接入处理线程类图 (6)4.2 接收线程类图 (7)4.3 启动控制图 (7)5 程序设计说明 (8)5.1 对原系统的改动 (8)5.2 ThreadInSvcProcessor 接入处理器 (9)5.2.1 类图 (9)5.2.2 时序图 (10)5.2.3 流程图 (10)5.2.4 ThreadInSvcProcessor类说明 (12)5.3 PatternNewSyncAsyncInnerDir 同异步向内处理模式 (17)5.3.1 类图 (17)5.3.2 描述 (18)5.3.3 流程图 (18)5.3.4 类说明 (20)5.4 ThreadReplySvcProcessor 异步应答返回处理器 (25)5.4.1 类图 (25)5.4.2 类说明 (25)5.5 ClientInfo 客户端连接数据 (34)5.5.1 类图 (34)5.5.2 类描述 (34)5.6 ClientInfoTable 客户端连接数据表 (35)5.6.1 类图 (35)5.6.2 类描述 (35)5.7 ClientInfoTableMonitor 客户端连接数据表监控程序 (39)5.7.1 类图 (39)5.7.2 类说明 (39)5.8 FrontMain 主控程序 (41)5.8.1 类间关系 (41)5.8.2流程图 (42)5.8.3 类说明 (43)5.9 问题 (45)1编写目的预期读者：对接口行为和目的有一定了解的人背景说明⏹软件系统名称：接口前端接入服务器⏹描述<接口> 接收不同商家的接入，接收数据转发给主机服务器，并同步/异步将返回数据发给接入商家的行为2名词解释⏹ChannelBase 渠道,通信基类，提供数据收发和释放的方法接口用子类实现来封装了不同通信方式目前有TCP短连接接入，从ACE Message_Queue中读取（IPC MessageQueue-> ACE_Message_Queue）⏹Trade* trade 商家对象，代表的其实是针对该商家处理方法的集合将接入数据的商家称为服务商家而将请求面向的商家称为主机商家，主机商家负责同步/异步返回交易的应答数据给接口平台⏹而接口（数据交换）平台是在两者之间的交换平台⏹渠道工厂：把接入数据的渠道工厂统一定为服务渠道工厂，发送数据的渠道工厂统一定为主机通道工厂服务商家接口平台主机商家3 组件分布图ATM查不到,丢弃返回应答线程组ATM 接入服务器ATM 连接队列TCP 渠道IPC 消息队列渠道commserverIPC 消息队列注各种服务渠道和主机通道抽象类都是相同的基类ChannelBase ，只是作用不同渠道工厂生成各种渠道IPC 消息队commserver 银联 接入服务渠道抽象 代表各种接入服务渠道接出服务渠道抽象 TCP 渠道IPC 消息队列渠道发送请求线程组后台服务器连接监视器IPC 消息队列通知清除超时连接记录表接收线程 接收IPC 消总控接入主机通道抽象IPC 消息队列渠道4程序结构4.1 接入处理线程类图ThreadInSvcProcessor是接入处理线程的主流程收数，接包无误后将处理控制权交给ProcessPattern是后续处理的全部流程抽象类PatternNewSyncAsyncInnerDir是ProcessPattern的一个子类，实现发送主机服务器并判断同/异步返回同步直接返回给接入商家异步只做相应记录4.2 接收线程类图4.3 启动控制图5程序设计说明5.1 对原系统的改动⏹改变原有商家Trade类，不存放渠道对象在商家类中，商家类只执行商家处理，不负责渠道的管理⏹改动原有的系统中所有模式的处理，模式处理必须对渠道的释放负责⏹修改MidHstChannel，添加后台服务需要的２个FML字段,这两个字段是:FML域名描述S_INTERF_NO 接口标识号，整数。
接口文档范例示意
接口文档范例示意文章标题：接口文档范例示意 - 简单易懂的API文档设计与编写引言：在软件开发过程中，为了实现不同系统之间的互联互通，接口文档的编写变得尤为重要。
好的接口文档不仅能够提供清晰的指导，还能减少开发者之间的沟通成本，提高开发效率。
本文将以一个示意的接口文档范例为例，探讨如何编写一份简单易懂的API文档。
第一部分：接口概述1.1 接口名称和版本信息在接口概述中，首先需要明确接口的名称和版本信息。
例如：接口名称：用户管理接口版本号：v1.01.2 接口描述在接口描述中，应该简要说明该接口的作用和功能。
例如：该接口用于对系统中的用户进行管理，包括用户的创建、查询、更新和删除等操作。
1.3 接口区域信息和请求方式在接口区域信息和请求方式中，需要提供接口的URL区域信息以及HTTP请求的方式。
例如：接口区域信息：/api/users请求方式：GET第二部分：请求参数2.1 公共请求参数公共请求参数是指在每个接口中都需要使用的参数，例如身份认证信息、时间戳等。
在该部分中，列举出每个公共请求参数的名称、类型和是否必填。
例如：- access_token（字符串，必填）：用于身份认证的令牌。
- timestamp（字符串，必填）：请求的时间戳。
2.2 接口请求参数接口请求参数是指该接口所需的具体参数，包括请求方法（GET、POST等），请求体中的参数以及可选的路由参数等。
在该部分中，详细描述每个请求参数的名称、类型、是否必填、描述以及示例值。
例如：- name（字符串，必填）：用户姓名。
- age（整数，选填）：用户年龄。
- gender（字符串，选填）：用户性别。
示例值：'male'或'female'。
第三部分：响应参数3.1 公共响应参数公共响应参数是指在每个接口的响应结果中都会返回的参数，例如状态码、错误信息等。
在该部分中，列举出每个公共响应参数的名称、类型和描述。
泛微Ecology外部门户接口说明
Ecology门户接口说明SUBMITTED BY WEA VER SOFTWARE 仅限阅读请勿传播当您阅读本方案时，即表示您同意不传播本方案的所有内容文档版本变更日期版本更改章节更改说明修改人序号1 2007-2-1 V1.0 无新文件曾东平2 2010-3-9 V1.1 加入了参数HostUrl 曾东科目录一、概述： (4)二、接口 (4)1.新闻列表 (4)2.文档内容 (5)3.部分样例 (6)一、概述：此文档仅提供用户从外网访问Ecology 时所需的接口，标准和部分样例，如果有新的接口的产生将会更新这个文件 实现原理: 相关的参数XML （RSS ）数据二、接口 1.新闻列表参数名称 解释 是否必填 默认值 npid 新闻页的ID是 ni 是否仅得到新闻页信息（0:不是 1:是） 否 0 ps 返回的条数 否 5 pi 返回的当前页数否 1 st 排序类型（0:升序 1:降序）否1 hostUrlOa 的访问地址 如： 是说明:1） 访问方式: http://oa 服务器域名/join/NewsList.jsp?npid=新闻页的ID （后面还可以跟其它参数）2) npid 是必填项，它指的是在Ecology 系统中新闻设置时的新闻页的ID<?xml version="1.0" encoding="gb2312" ?> <rss version="2.0"> <channel><title><![CDATA[ 泛微外部门户访问新闻页]]></title> 表示新闻页名称<description><![CDATA[ 外部访问新闻页]]> </description> 表此新闻页的描述 <language>zh-cn</language><generator><![CDA TA[ Ecology System]]></generator> <count>16</count> 表此新闻页中的记录总数外部网站 OA 系统</channel><item> 以下表示的是第一条新闻的数据<newsid>100020</newsid> 新闻ID<title><![CDATA[ 测试用外部新闻]]></title> 新闻标题<link><![CDATA[ /join/News.jsp?nid=100020]]></link> 新闻链接<pubDate><![CDA TA[ 20061207 10:13:51]]> </pubDate> 新闻的发布日期<description><![CDATA[ 测试用外部新闻]]></description> 新闻的摘要说明<author><![CDA TA[ 方观生]]></author> 新闻的创建者</item><item> 以下是第2到n条新闻...</item></rss>4)用户在得到此XML文件后就可以根据文件内标红的解释来解析XML代码，然后可以组织成所需要的数据格式5)错误信息:没有指定新闻页或新闻页不能为负数此新闻页不是外部新闻不能通过此接口浏览6）对新闻的排序是以最后修改日期与最后修改时间进行排序的2.文档内容参数名称解释是否必填默认值nid 新闻ID 是hostUrl Oa的访问地址如： 是说明:1）访问方式: http://oa服务器域名/join/News.jsp?nid=新闻ID<?xml version="1.0" encoding="gb2312" ?><rss version="2.0"><channel><title><![CDATA[]]></title><description><![CDATA[]]></description><language>zhcn</language><generator><![CDA TA[ Ecology System]]></generator></channel><item><newsid>100020</newsid><title><![CDATA[ 测试用外部新闻]]></title><link><![CDATA[ /join/News.jsp?nid=100020]]></link><pubDate><![CDA TA[ 20061207 10:13:51]]></pubDate><description> <![CDA TA[ 测试用外部新闻]]></description><content><![CDATA[<!DOCTYPE HTML PUBLIC "//W3C//DTD HTML 4.0 Transitional//EN"><HTML><HEAD><META httpequiv=ContentType content="text/html; charset=unicode"><META content="MSHTML 6.00.2900.2995" name=GENERATOR></HEAD><BODY><P><FONT face=宋体><IMG alt=imgCompetencyWeb.jpg src="/weaver/weaver.homepage.HomepageCreateImage?fileid=100078"></FONT></P><P><FONT face=宋体>继续努力</FONT></P></BODY></HTML>]]></content><author><![CDA TA[ 方观生]]></author></item></rss>3)用户在得到此XML文件后就可以根据文件内标红的解释来解析XML代码，可以组织成所需要的数据格式。
接口文档模板范文
接口文档模板范文一、接口概述1.接口名称：（接口的名称，用于标识接口的功能）2.接口描述：（对接口的功能进行简单描述）3.接口版本：（接口的当前版本号）5. 接口类型：（接口的类型，例如：RESTful API、SOAP等）6.接口地址：（接口的URL地址）二、接口参数1.请求参数：（1）参数名称：（参数的名称）参数类型：（参数的数据类型，例如：String、int等）是否必填：（参数是否必填，取值范围为：是、否）参数描述：（对参数的功能进行详细描述）2.响应参数：（1）参数名称：（参数的名称）参数类型：（参数的数据类型，例如：String、int等）参数描述：（对参数的功能进行详细描述）三、接口请求示例1.请求URL：（接口的请求URL）2.请求方式：（接口的请求方式，例如：GET、POST等）3.请求参数：（1）参数名称：（参数的名称）参数值：（参数的具体值）四、接口响应示例1.响应状态码：（接口的返回状态码）2.响应结果：（1）参数名称：（参数的名称）参数值：（参数的具体值）五、接口错误码1.错误码说明：（错误码的详细说明）2.错误码列表：（1）错误码：（错误码的具体值）错误描述：（对错误码的详细说明）六、接口调用示例1. 调用方式：（如何调用接口，例如：使用curl命令进行调用）2.调用示例：（具体的调用示例，包括请求URL、请求方式、请求参数、响应结果等信息）七、接口变更记录1.版本号：（接口的版本号）变更日期：（接口变更的日期）变更内容：（接口变更的具体内容）八、接口使用注意事项1.注意事项一：（对接口的使用进行注意事项的说明）2.注意事项二：（对接口的使用进行注意事项的说明）以上为接口文档模板的基本内容，具体根据实际项目需求进行调整和添加。
接口文档的编写应该充分考虑用户的需求，提供详细的说明和示例，并且及时更新维护，以便用户正确使用和理解接口的功能。
统一身份认证平台集成接口文档
三峡大学统一身份认证平台接口文档目录1.统一身份认证简介 (3)1.1 背景知识 (3)1.1.1 什么是单点登录（Single Sign On）： (3)1.1.2 中心认证服务的设计愿景： (3)1.2 CAS的实现 (4)系统中的用到的凭证（ticket）： (5)2.JAVA语言 (6)2.1 CAS简单登陆的实现 (6)2.2 CAS登出 (12)3.PHP语言 (13)3.1 CAS单点登录测试环境搭建步骤 (13)3.1.1 获取必要的驱动程序： (13)3.1.2 搭建php运行环境 (13)3.1.3 配置PHP cas 客户端测试程序 (13)3.2 PHP-CAS客户端 (14)3.2.1 cas-client的初始化 (14)3.2.2 设置不是SSL的CAS认证 (16)3.2.3 进行CAS认证 (17)3.2.4 登出 (20)语言 (22)4.1 搭建环境 (22)4.2 CAS简单登陆实现 (22)4.3 CAS登出实现 (23)5.ASP语言 (24)5.1 CAS简单登录实现 (24)5.2 CAS登出实现 (25)6.附录 (26)6.1 附录1 (26)6.2 附录2 (28)6.3 附录3 (30)6.4 附录4 (31)6.5 附录5 (32)1.统一身份认证简介1.1背景知识1.1.1 什么是单点登录（Single Sign On）：所谓单点登录是指基于用户/会话认证的一个过程，用户只需一次性提供凭证（仅一次登录），就可以访问多个应用。
目前单点登录主要基于Web的多种应用程序，即通过浏览器实现对多个B/S架构应用的统一账户认证。
1.1.2 中心认证服务的设计愿景：简单的说，中心认证服务（Central Authentication Service 缩写：CAS）的目的就是使分布在一个企业内部各个不同异构系统的认证工作集中在一起，通过一个公用的认证系统统一管理和验证用户的身份，一般我们称之为统一身份认证平台。
接口文档范文
接口文档范文1. 引言接口文档是软件开发中非常重要的一部分，它定义了系统与外部系统或组件之间的通信接口。
本文档旨在提供一个接口文档范文，以便开发人员编写规范的接口文档，确保系统能够与其他系统或组件正确地交互。
2. 接口概述本接口文档描述了一个名为“示例系统”的接口规范。
该系统提供了一组RESTful API，用于管理用户信息。
通过这些接口，可以进行用户的创建、读取、更新和删除操作。
2.1 接口基本信息•接口名称：用户管理接口•接口版本：1.0.0•接口地址：``2.2 接口认证本接口要求进行身份认证，使用OAuth 2.0协议进行授权。
在每个请求中，需要在请求头中添加Authorization字段，其值为Bearer <access_token>，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"}]3.2 获取单个用户信息•接口路径：GET /users/{id}•接口描述：根据用户ID获取单个用户的详细信息•请求参数：–id：用户ID（整数，路径参数）•响应参数：–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"}3.3 创建用户•接口路径：POST /users•接口描述：创建一个新用户•请求参数：–name：用户姓名（字符串，必填）–email：用户邮箱（字符串，必填）•响应参数：–id：用户ID（整数）–name：用户姓名（字符串）–email：用户邮箱（字符串）–created_at：用户创建时间（字符串，格式为YYYY-MM-DD HH:MM:SS）•响应示例：{"id": 3,"name": "Alice Brown","email":"*****************","created_at": "2021-01-03 12:00:00"}3.4 更新用户信息•接口路径：PUT /users/{id}•接口描述：更新指定用户的信息•请求参数：–id：用户ID（整数，路径参数）–name：用户姓名（字符串，可选）–email：用户邮箱（字符串，可选）•响应参数：–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"}3.5 删除用户•接口路径：DELETE /users/{id}•接口描述：删除指定用户•请求参数：–id：用户ID（整数，路径参数）•响应参数：无•响应示例：无4. 错误处理本接口遵循HTTP状态码规范进行错误处理。
接口文档范文
接口文档范文一、概述接口文档是用来描述软件系统接口的一种文档，它详细说明了系统中各个接口的功能、参数、调用方法等。
接口文档是开发人员进行开发和集成的重要参考资料，也是不同系统之间进行数据交互的重要依据。
本文将以一个示例接口文档为范本，详细介绍接口文档的内容和编写要求。
二、接口名称接口名称：用户注册接口三、接口描述该接口用于用户注册功能，用户可以通过该接口完成账号的注册。
四、接口地址接口地址：/api/register五、请求方法POST六、请求参数参数名类型是否必填描述username string 是用户名，长度为6-20个字符password string 是密码，长度为6-20个字符email string 是邮箱地址七、请求示例{"username": "testuser","password": "123456", "email":"****************"}八、返回参数参数名类型描述code int 返回码，0表示成功，-1表示失败message string 返回消息九、返回示例{"code": 0,"message": "注册成功"}十、错误码错误码描述-1 注册失败1001 用户名已存在1002 邮箱已被注册十一、接口备注无十二、接口变更记录版本号修改时间修改内容1.0 2021-01-01 初始版本1.1 2021-02-01 增加返回参数code和message结论接口文档是软件开发过程中必不可少的一部分，它起到了明确各个接口的功能和使用方法的作用。
本文以一个用户注册接口为例，详细介绍了接口文档的内容和编写要求。
在实际编写接口文档时，需要确保内容准确严谨，避免歧义或错误信息的出现。
同时，良好的结构和清晰的语言描述也是编写接口文档的重要要求。
中国电信用户门户接口规范.pdf
3 缩略语..............................................................................................................................................6
4 需求约束..........................................................................................................................................6
5 门户在业务网络中的位置..............................................................................................................6
6 移动业务网络用户门户与ISMP之间接口....................................................................................9
6.1 功能调用接口 .........................................................................................................................9 6.1.1 用户管理接口 .................................................................................................................9 6.1.2 认证与授权接口 ...........................................................................................................16 6.1.3 定购管理接口 ...............................................................................................................19 6.1.4 终端信息查询接口 .......................................................................................................30
业主版对外接口文档（最新版）
业主一、登录（1）登录* URI /community/api/login* 请求方式POST* 请求头token* 参数phone//用户电话pass//登录密码* 响应{"success":true,"message":"OK","code":200,"data":{"reason":"登录成功","statuscode":"000000",//状态码"port":"5070",//端口"sipaccount":"186****8185",//sip账户"sippassword":"123456",//sip密码"ipaddr":"","token":"316A706052B84FD0AE2E166B6EADEB35","openId":""},"date":"2017-11-29 10:28:25","state":null}（2）退出登录* URI /community/api/owner/quite* 请求方式POST* 请求头token* 参数* 响应{"success": true,"message": "ok","code": 200,"data": null,"date": "2017-11-06 17:38:46"}二、注册* URI /community/api/owner/register * 请求方式POST* 请求头token* 参数phone //电话号码verifycode //验证码pass //密码* 响应{"success":true,"message":"注册成功","code":200,"data":null,"date":"2017-11-29 10:33:18",}三、获取验证码* URI /community/api/owner/verifycode * 请求方式POST* 请求头token* 参数phone//用户电话* 响应{"success":true,"message":"OK","code":200,"data":null,"date":"2017-11-29 10:33:18","state":null}四、获取用户所有的小区信息* URI /community/api/owner/cells* 请求方式POST* 请求头 token* 参数provinceId //省IDcityId //市IDareaId //区县IDstreetId //街道ID* 响应{"success":true,"message":"OK","code":200,"data":{"data":[{"createDate":null,"modifyDate":null,"createUser":null,"status":null,"sorted":null,"remark":null,"cellId":"B5A4BF05959C4CFAA1805F8AAAF4C839",//小区ID "cellName":"cesce",//小区名称"accessId":null,"shopId":null,"advType":null,"cellAddress":"the","longitude":null,"latitude":null,"areaLand":null,"areaConstruction":null,"committeeId":null,"noteId":null,"phoneGatewayId":null,"totalCount":null,"useCount":null,"logo":null,"term":null,"ip":null,"port":null,"appPrivateKey":null,"appPublicKey":null,"appId":null,"appName":null,"userName":null,"userPhone":null,"account":null,"roleId":null,"userType":null,"code":null,"sip":null,"sipPass":null,"concat":null,"securityKey":null,"csipPass":null,"delay":null,"quick0":null,"quick1":null,"quick2":null,"quick3":null,"quick4":null,"quick5":null,"quick6":null,"quick7":null,"quick8":null,"quick9":null,"program":null,"programName":null,"pushaccountId":null,"ownerMaster":null,"ownerAppkey":null,"communityMaster":null,"communityAppkey":null,"unitId":null,"buildingId":null,"provinceId":null,"provinceName":null,"cityId":null,"cityName":null,"areaId":null,"areaName":null,"streetId":null,"streetName":null},],"pageInfo":{"limit":10,"page":1,"totalCount":2,"nextPage":1,"hasPrePage":false,"prePage":1,"hasNextPage":false,"startRow":1,"endRow":2,"totalPages":1,"slider":[1],"lastPage":true,"firstPage":true,"offset":0}},"date":"2017-12-04 17:35:56", "state":null}五、绑定小区住所* URI /community/api/owner/changecell* 请求方式POST* 请求头 token* 参数roomId //房间Id* 响应{"success":true,"message":"绑定OK","code":200,"data":{"createDate":null,//创建日期"modifyDate":null,//修改日期"createUser":null,//创建人"status":1,"sorted":null,"remark":null,"ownerId":"0E11B890D54444128B2D5E0BCA7B5B28",//用户Id"ownerName":"余长发",//用户名称"ownerPhone":"186****8185",//用户电话"ownerPass":null, //用户密码"nickName":null, //用户昵称"headImg":"/1123/A3CAF FF22E174D7F9B0D3878C705C160_20171123113335.png",//用户头像"lastLogin":null, //最后登录时间"loginCount":null, //登录次数"speackStatus":1,"integral":"1028",//用户积分"deiceId":null,"cellId":"1CF3E2B8BB1B493CA2935EDD0BB1CEA3",//小区Id"buildingId":"232D0B20515242448CBA2EE930080255",//楼栋Id"unitId":"096BF6C7FEEA43C2BA21745B5217BEF6",//单元Id"roomId":"6EA8870A1A2447FD9A6A654BF168DA31",//房间Id"ownerType":2, //住户类型"verifyState":null,"buildingName":"1",//楼栋名称"unitName":"1",//单元名称"roomNum":"0101",//房间号"cellName":"郑州国际小区",//小区名称"identify":null,"code":"37101","sip":"155****0098",//sip账号"sipPass":"700098",//sip密码"concat":"155****0098",//联系人"authentication":true, //验证状态（true已验证，false未验证）"enabled":true, //启用状态（true启用false禁用）"call":null, //呼叫转移"matchRoomNum":null,"matchPhone":null},"date":"2017-11-29 10:43:22","state":null}六、广告内容(1) 获取广告内容(app)* URI /community//api/adv/queryAdvList* 请求方式POST* 请求头token* 参数code:‘AppIndex'/*广告位编号（AppIndex（首页），AppCommunity（社区），APPLife（生活））*/* 响应{"success":true,"message":"OK","code":200,data”: [{"content":"/201710/20171017093332915.jpg" //内容}],"date":"2017-11-29 11:23:09","state":null}(2)获取广告内容（广告机器）* URI /community/api/adv/queryAdvDetailList * 请求方式POST* 请求头* 参数code //广告位编号（AppIndex，AppCommunity，APPLife）mac //mac地址或者设备序列号* 响应{“success”: true,“message”: “OK”,“code”: 200,“data”: [{"content":"/201710/20171017093332915.jpg" 内容}],“date”: “2017-10-19 15:14:25”,“state”: null}七、获取物业通知* URI /community/api/push/queryPushInfoList * 请求方式POST* 请求头token* 参数* 响应{"success":true,"message":"获取成功","code":200,"data":[{"pushId":"a1b8433d2b5844ea8ac0c870835ba035",//通知Id"starttime":"2017-11-10 10:04:34.0",//开始时间"starttimeStr":null,"committeeId":null,"cellId":"9730DBA0C887417A8978B6C1C12F3AA2",//小区Id"accessId":null,"userId":"EDB06FE47EB34FD688F117DD6D312EE9",//用户Id"title":"测试", //通知标题"content":"111", //通知内容"pushTime":"2017-11-17 09:41:43.0", //发布时间"cellName":"测试小区#1",//发布小区"userName":"余文朋"//发布者}],"date":"2017-11-29 11:30:36","state":null}八、获取实时动态日志列表* URI /community/api/optionLog* 请求方式POST* 请求头token* 参数type //动态类型不传为首页 1物业 2生活服务 */* 响应{"success":true,"message":"OK","code":200,"data":[{"createDate":null,"modifyDate":null,"createUser":null,"status":null,"sorted":null,"remark":null,"gid":"100151134497150400","optionId":"57D8816BD6324E4B9B434251E002FA23","optionType":"14",// 1家政服务 2投诉建议 3借用物品 4访客通行 5物业缴费 6车辆缴费 7物业通知 11周边生活 12家有喜事 13社区活动 14交易市场 15新闻咨询"type":"2", //动态类型 1物业 2服务"createdate":"2017-11-22 18:02:51.0",//创建时间"stateName":null,// 状态名称"typeName":"",//标题名称"content":"/1122/05B603D2E5 A541C49473A6DD1B3C7C23.png",//内容"price":null, //金额"optionTypeName":null,"regUserId":null,"numberId":null,"cellId":"9730DBA0C887417A8978B6C1C12F3AA2"},{"createDate":null,"modifyDate":null,"createUser":null,"status":null,"sorted":null,"remark":null,"gid":"100151131472344900","optionId":"76ee2418309e475a8e42956d93c2a01e","optionType":"12","type":"2","createdate":"2017-11-22 09:38:43.0","stateName":"已同意","typeName":null,"content":null,"price":null,"optionTypeName":null,"regUserId":null,"numberId":null,"cellId":null}],"date":"2017-11-29 11:34:52","state":null}九、门禁管理（1）获取用户所有门禁* URI /community/api/door/doors* 请求方式POST* 请求头token* 参数phone//用户电话* 响应{"success":true,"message":"OK","code":200,"data":[{"createDate":null,"modifyDate":null,"createUser":null,"status":null,"sorted":null,"remark":null,"doorId":"581F1D910A3D4DE48661B7C6EED67A74",//门禁ID"serial":"36838",//序列号"communityName":"不夜小区",//小区"doorName":"棒棒棒",//设备名称"doorType":2222,//设备了类型（1111远程2222密码3333sip4444蓝牙5555wifi）"sourceIp":null,"sourcePort":null,"destinationIp":null,"destinationPort":null,"instruct":null,"responseCode":null,"secretKey":null,"customerPhone":null,"customerName":null,"customerId":null,"doorgroupId":null,"usergroupId":null,"boundId":null,"longitude":null,"latitude":null,"leftLongitude":null,"leftLatitude":null,"rightLongitude":null,"rightLatitude":null,"program":null,"sip":null},{"createDate":null,"modifyDate":null,"createUser":null,"status":null,"sorted":null,"remark":null,"doorId":"09BEA3405ED043E281003BF30FBFB5B6", "serial":"6399999969/","communityName":"不夜小区","doorName":"不夜","doorType":5555,"sourceIp":null,"sourcePort":null,"destinationIp":null,"destinationPort":null,"instruct":null,"responseCode":null,"secretKey":null,"customerPhone":null,"customerName":null,"customerId":null,"doorgroupId":null,"usergroupId":null,"boundId":null,"longitude":null,"latitude":null,"leftLongitude":null,"leftLatitude":null,"rightLongitude":null,"rightLatitude":null,"program":null,"sip":null}],"date":"2017-11-30 16:10:06","state":null}（2）远程开门* URI /community/api/door/open * 请求方式POST* 请求头token* 参数phone//当前用户的手机号码door //门禁ID* 响应{"success":true,"message":"OK","code":200,"data":{"reason":"登录成功","statuscode":"000000",//状态码"port":"5070",//端口"sipaccount":"186****8185",//sip账户"sippassword":"123456",//sip密码"ipaddr":"","token":"316A706052B84FD0AE2E166B6EADEB35","openId":""},"date":"2017-11-29 10:28:25","state":null}（3）sip开门* URI /community/api/door/sip * 请求方式GET* 请求头token* 参数account:phone, //账户--登录账户pass:password, //密码--登录密码to:sip, //目标设备(mac)content:serial //消息内容--序列号* 响应{"statuscode":"000000","reason":"成功"}（4）密码开门* URI /community/api/door/getkey * 请求方式POST* 请求头token* 参数phone:phone, // 当前用户的手机号码door:doorId // 门禁的id值* 响应{"success":true,"message":"OK","code":200,"data":"2894","date":"2017-11-30 16:19:05","state":null}（5）扫码开门* URI /community/api/code* 请求方式POST* 请求头token* 参数phone // 当前用户的手机号码seria // 门禁的序列* 响应十、停车场（1）检索停车场* URI /community/api/park* 请求方式GET* 请求头token* 参数* 响应{"success":true,"message":"OK","code":200,"data":[{"createDate":"2017-10-27 11:37:26.0","modifyDate":null,"createUser":null,"status":null,"sorted":null,"remark":null,"parkId":"AA94769547C84522ADCF4AE08AF138EB","name":"测试",//停车场名称"ip":"120.27.121.28",//停车场ip"port":"10086",//端口"version":"V6",//版本"state":"ENABLED","chargingDate":null,"databaseIp":"120.27.121.28",数据库IP"databasePort":"10088",//数据库端口"databaseUserName":"sa",//数据库用户名"databasePassword":"123456",//数据库密码"databaseName":"Yktv56",//数据库名称"dataVersion":"5.6",数据库版本"aliPayId":"0FEA48A265E34AD7BCCC4F3AF61BF6D2",//支付宝ID"aliPayName":"停车场支付宝",//支付宝名"wxPayId":null,//微信支付ID"wxPayName":null,//微信支付名"totalCount":null,"overCount":null,"ruleType":null,"ruleTypeName":null,"cellId":null,"mac":null}],"date":"2017-11-30 17:06:47","state":null}（2）临时缴费查询* URI /community/api/park/v1/accountmoney * 请求方式POST* 请求头token* 参数carNum //车牌号parkId //车场Id* 响应（3）月租续费* URI/community/api/park/v1/orderMonthCardDefer* 请求方式POST* 请求头token* 参数carNum //车牌号months //月份parkId //车场Id* 响应（4）生成支付宝订单(web)* URI /community/api/order/createAlipayOrder * 请求方式POST* 请求头token* 参数order_num, //订单号car_num, //车牌号park_id, //车场IDtotal_fee, //金额return_url //重定向页面subject //标题* 响应十一、物业缴费（1）获取未交费总金额* URI /community/api/bill/findTotalMoney* 请求方式POST* 请求头token* 参数* 响应{"success":true,"message":"获取成功","code":200,"data":"900.00",//未缴总费用"date":"2017-11-30 13:13:49","state":null}(2)获取缴费列表* URI /community/api/bill/queryBillInfoList * 请求方式POST* 请求头token* 参数stateId //状态 0未支付 1已支付* 响应{"success":true,"message":"获取成功","code":200,"data":[{"createDate":null,"modifyDate":null,"createUser":null,"status":null,"sorted":null,"remark":"自动生成物业费",//缴费类型"billId":"b74a922e335540079779fe5a644f761e",//订单号"billName":"物业费",//订单名称"typeId":"1",//订单类型ID"userId":null,//用户id"numberId":"BB02DA149B86471DADFA5F8751C8FF7B", "price":"1.80",//单价"num":"250",//数量"totalMoney":"450.00",//此类型费用"stateId":"0",//0未缴1已缴"fromType":null,"starttime":null,"externalTradeNo":null,"externalRespCode":null,"totalFee":null,"accountReceivable":null,"month":"2017-11","orderNo":"","cellId":null,"buildingId":null,"unitId":null,"cellName":"重庆特迪智慧小区",//小区名称"buildingName":"2栋",//楼栋"unitName":"2单元",//单元"numberName":"0101",房间"userName":null,"billIds":null},{"createDate":null,"modifyDate":null,"createUser":null,"status":null,"sorted":null,"remark":"自动生成物业费","billId":"fc4a2b14adca4c5ba8365f216bf4662a","billName":"物业费","typeId":"1","userId":null,"numberId":"BB02DA149B86471DADFA5F8751C8FF7B", "price":"1.80","num":"250","totalMoney":"450.00","stateId":"0","fromType":null,"starttime":null,"externalTradeNo":null,"externalRespCode":null,"totalFee":null,"accountReceivable":null,"month":"2017-10","orderNo":"","cellId":null,"buildingId":null,"unitId":null,"cellName":"重庆特迪智慧小区","buildingName":"2栋","unitName":"2单元","numberName":"0101","userName":null,"billIds":null}],"date":"2017-11-30 13:24:10","state":null}(3)获取预交物业费* URI/community/api/bill/queryBillGatherList * 请求方式POST* 请求头token* 参数* 响应{"success":true,"message":"OK","code":200,"data":[{"createDate":null,"modifyDate":null,"createUser":null,"status":null,"sorted":null,"remark":null,"gid":"008fcbc7ba6240eca4844a326df0f3a3","name":"物业费6个月",//预交物业费类型名称"monthCount":"6",//6个月起交"money":"1893.36",//费用"cellId":"C3D7278A9458488CB8B22B278730DA0E",//小区ID"createdate":"2017-07-29 23:51:36.0",//创建日期"moditydate":null},{"createDate":null,"modifyDate":null,"createUser":null,"status":null,"sorted":null,"remark":null,"gid":"35ff9c80baf748dab347e256b8e8bd2b","name":"物业费1年","monthCount":"12","money":"3477.60","cellId":"C3D7278A9458488CB8B22B278730DA0E","createdate":"2017-07-29 23:48:37.0","moditydate":null}],"date":"2017-11-30 13:32:57","state":null}(4)获取预交物业费支付宝参数* URI /community/api/bill/billGatherAlipay * 请求方式POST* 请求头token* 参数total_fee //支付总金额billId //物业费id （多个用,分隔开）subject //标题* 响应{"success": true,"message": "OK","code": 200,"data":"alipay_sdk=alipay-sdk-java-dynamicVersionNo&app_id=2017051907289088&biz_content=%7B%22body%22%3A%22%E9%A2%84%E4%BA%A4%E7%89%A9%E4%B8%9A%E8%B4%B9%22%2C%22out_trade_no%22%3A%221151028746282200%22%2C%22product_code%22%3A%22QUICK_MSECURITY_PAY%22%2C%22subject%22%3A%22%E7%89%A9%E4%B8%9A%E8%B4%B9%22%2C%22timeout_express%22%3A%2230m%22%2C%22total_amount%22%3A%221597.01%22%7D&charset=utf-8&format=json&method=alipay.trade.app.pay¬ify_url=http%3A%2F%%2Fcommunity%2Fapi%2Fbill%2FblockGatherAliPay&sign=P4G%2Fw9Az%2F%2FUypv7BbaW6IRwL53jIaTzKGAAbl9QFwz4S95H%2Fqy%2Bm3IJ%2FIW8KupB4xZt%2BTl6oM0YwkJWzKBW%2FremV52cL%2FJhAsDPVY1DwOP8oug9rHwutGafWTJ69tFT%2BSg692CdhWeO3gQpPwxbMHZqS2DTsUsUf4BW8YNNUYA8zhorY8COVqx8UDFWiBxXNZO0OC3EFSBRw9njJ0l4sVvKpYA6nZ6hALOi13m4pm%2BXQiEFyGGwzBg1WWwXnIIdfBkDw2Bx26xsgzwibO0eb8FTjWC%2Fnx1zROGFcr9xcP2UCLwkHijCUwCzB5OmUoTSDfLlwXuCbCaIYmFj5fW%2BgOg%3D%3D&sign_type=RSA2×tamp=2017-11-10+12%3A17%3A42&version=1.0&sign=P4G%2Fw9Az%2F%2FUypv7BbaW6IRwL53jIaTzKGAAbl9QFwz4S95H%2Fqy%2Bm3IJ%2FIW8KupB4xZt%2BTl6oM0YwkJWzKBW%2FremV52cL%2FJhAsDPVY1DwOP8oug9rHwutGafWTJ69tFT%2BSg692CdhWeO3gQpPwxbMHZqS2DTsUsUf4BW8YNNUYA8zhorY8COVqx8UDFWiBxXNZO0OC3EFSBRw9njJ0l4sVvKpYA6nZ6hALOi13m4pm%2BXQiEFyGGwzBg1WWwXnIIdfBkDw2Bx26xsgzwibO0eb8FTjWC%2Fnx1zROGFcr9xcP2UCLwkHijCUwCzB5OmUoTSDfLlwXuCbCaIYmFj5fW%2BgOg%3D%3D", 加签支付宝参数"date": "2017-11-10 12:17:43","state": null}(5)获取订单号* URI /community/api/bill/createOrder* 请求方式POST* 请求头token* 参数billId //账单id（非必传）* 响应{"success": true,"message": "获取成功","code": 200,"data": "2015060708",//订单号"date": "2017-04-25 11:33:04"}(6)获取支付宝参数* URI /community/api/pay/aliPay* 请求方式GET* 请求头* 参数total_fee //总金额return_url //返回地址（非必填）orderNum //订单编号notify_url //回调地址subject //标题* 响应{"success": true,"message": "获取成功","code": 200,"data": "支付宝参数字符串","date": "2017-04-25 11:33:04"}(7)跳转支付宝支付（网页）* URI /community/api/pay/createAlipayOrder * 请求方式GET* 请求头* 参数total_fee //总金额return_url //返回地址（非必填）orderNum //订单编号notify_url //回调地址subject //标题* 响应(8)支付回调* URI /community/api/ownerIntegral/add* 请求方式POST* 请求头token* 参数* 响应十二、商城(1)获取商品列表* URI /community/api/shop/queryCommodityList * 请求方式 POST* 请求头token* 参数shopId //商铺IDname //商铺名称classType //商铺类型 0商城 2小区直营isRecommend //是否推荐 0否 1是classId //商品类别shopTypeId //商铺类别rows, //获取条数默认10page //获取第几页数据默认1* 响应{"success": true,"message": "获取成功","code": 200,"data": [{"createDate": null,"modifyDate": null,"createUser": null,"status": null,"sorted": null,"remark": null,"shopId":"1e5e8f2a192f4daab954229219832b91",// 商铺ID"commodityId": "07c014f70adf4e3bb54546009ee385df",//商品ID"commodityName": "重庆啤酒",//商品名称"marketPrice":"4.00",//市场价"price":"2.00", //现价"details":null,// 商品描述"stock": 20000, //库存"stateName":"正常", //商品状态"sorce": 0, //商品评论积分"commentCount": 0,//评论数"className": "酒水",// 类别"imgList": [{"imgUrl":"/201704/20170425154408524.png", //图片地址}]}],"date": "2017-04-25 15:57:26"}(2)获取商铺列表* URI /community/api/shop/queryShopList* 请求方式 POST* 请求头token* 参数classType //商铺类型 0商城 2小区直营classId //商品类别shopTypeId //商铺类别IDrows, //获取条数默认10page //获取第几页数据默认1* 响应{"success": true,"message": "获取成功","code": 200,"data": [{"shopId": "1143840446002100",// 商铺ID"shopTypeId": "1141802768304700",//商铺类别ID"shopName": "百家电器",/商铺名称"imgUrl":"upload/20150801/20150801124645826.png",//商铺图片地址"shopAddress": "红星市场", //商铺地址"phone":"188****6433",//商铺联系电话"longitude": "118.409954", // 商铺经度"latitude":"31.470041", //商铺维度"heartCount": "0000000000",//评分数"interval":1025410 //距离（单位米）"shopTypeName": "家电家私",//商铺类别名称}],"date": "2017-04-25 16:06:52"}(3)获取商品详情* URI /community/api/shop/view* 请求方式 POST* 请求头token* 参数comodityId //商品ID* 响应{"success": true,"message": "获取成功","code": 200,"data": {"shopId":"1144766201118200",// 商铺ID"commodityId":"100147444826493000",//商品ID"commodityName":"测试的",// 商品名称"marketPrice":"0.01",//商品市场价"price":"0.01", //商品价格"details":"<p><imgsrc=\"/upload/20160921/80241474448260597.gif\"style=\"float:none;\"title=\"177DN]OZTJC)INBRGC%2T`X.gif\"/></p><p><imgsrc=\"http:///upload/20160921/511474448261112.jpg\"style=\"float:none;\" title=\"A%]FJ7`)~_`~Z4H]YYRRH[R.jpg\"/></p><p><imgsrc=\"/upload/20160921/26921474448261241.gif\"style=\"float:none;\" title=\"AH~)R%)V7Y_H3M{V6_}3MHE.gif\"/></p><p><br/></p>",//商品详情"stateId":"0",//商品状态ID"stock":null, // 商品库存"shopName":"女装", //商铺名称"stateName":"正常"，//商铺状态名称"sorce":0, // 商品评分"commentCount":0, // 评论数"className":null, // 商品类别名称"imgList": [ {"imgUrl":"/201705/2017052511481341 2.png"}], // 商品图片地址"commodityProperyList": [{"properyId":"2ac6b7d234ec4ac19fd81a3310e5e9f1",// 属性ID"properyName": "重量", //属性名称"properyValueList": [{"properyValueId":"2d37bea6ede84093b9cbc5133d729e0a", // 属性值ID"properyValueName":"500g" //属性值名称},{"properyValueId":"72ea871ff8794719b72b51d75f4f7422","properyValueName": "1Kg"},{"properyValueId":"b640a10f74fe4ff086641b3181a260d0","properyValueName": "2kg"}]},{"properyId": "2d83fe9bea1746bba529f81180db4521","properyName": "口味","properyValueList": [{"properyValueId":"0a3748f50920401a81faf409b7efac7c","properyValueName": "甘甜"},{"properyValueId":"e372c92178aa4cdbb81bab37efa8da3f","properyValueName": "辛辣"}]。
中国万网域名API接口说明文档
中国万网域名A P I接口说明文档作者: HiChina版本：1.0发行日期：2006/08/10版本变更说明前言本文档描述了中国万网域名注册API接口协议。
本文档描述了基本的数据交换标准，其中包括数据格式，数据定义，以及一些相关约定。
目录1．API接口地址 (4)2．参数说明 (4)2．1公共参数 (4)2．2行为参数（ACTION） (5)2．2．1域名注册 (5)2．2．2修改联系人 (7)2．2．3域名续费 (8)2．2．4注册主机(创建域名服务器) (8)2．2．5修改解析服务器(域名DNS修改) (8)2．2．6修改域名密码 (9)2．2．7修改主机IP(修改域名服务器IP) (9)2．2．8域名转入 (9)2．2．9域名解析 (9)2.2.9.1 显示域名当前解析记录 (10)2.2.9.2 增加域名解析记录 (10)2.2.9.3 删除域名解析记录 (10)2.2.9.4 修改域名解析记录 (11)3.应答代码 (11)3.1.成功返回 (11)3.2.处理中返回，等待成功 (11)3.3.失败返回，不可能成功 (11)3.4.显示域名解析记录列表 (12)4.应用示例 (13)4．1CN英文域名注册 (13)4．2国际英文域名注册 (14)4．3国际中文域名注册 (14)4．4国内中文域名注册 (16)4．5国际英文域名续费 (17)4．6国内中文域名过户 (18)5．错误代码 (19)6.附件一：域名后缀 (21)6.1CN英文域名(国内英文域名) (21)6.2国内中文域名(CNNIC中文通用域名) (22)6.3国际英文域名 (22)6.4国际中文域名 (22)6.5N AME域名 (22)7.附件二：国家列表 (22)8.附件三：单位行业 (28)9.附件四: 域名WHOIS接口 (28)9.1域名CHECK (28)9.2域名INFO (29)1．API接口地址接口采用HTTP，POST协议：调用URL：http:// :8081/wwwnetcn.aspx调用说明：接口使用万网分销商级别的数字ID（以下本文档简称为数字ID），即可调用。
接口描述——精选推荐
1.1.1接口描述
任何的项目最注重的就是功能的实现，但是接口亦是系统中不可忽视的一环。
在本项目中通过用户界面和数据接口对接口进行描述。
1．界面设计
通过jsp进行了相关的页面设计，对企业、药品批发商友好，对鼠标和键盘提供支持，界面的设计遵循了以下的规则：
(1) 界面设计简洁明快，富有个人的特色，且不会有绚丽的色彩修饰；
(2) 界面提供简单的错误处理，给出相应的提示；
(3) 界面提供相应的功能信息反馈，用多种信息提示用户当前软件运行的状态，软件界面元件的功能；
(4) 操作可逆，由于所有的信息均在同一界面上显示出来，所以其操作的动作为单个的操作；
(5) 设计了良好的帮助性能；
(6) 遵循了计算机对于词汇的标准，用词精简准确，没有歧义，各界面的意义明朗。
2．数据接口
本系统的数据接口如下：
买家档案表，卖家档案表，商品信息表，买家商品关系表，卖家商品关系表。
蓝海卓越Portal接口描述
蓝海卓越Portal接口描述-V1.1修订记录2 开发准备2.1 接口地址开发的接口地址为http://portal地址:8088/portal/auth采用HTTP GET方式请求，并返回json目前的版本号为V1.13 接口描述3.1 接口方法描述3.1.1 plogin方法功能描述：用户登录函数声明：string plogin(string versions,string username,string password,string wlanuserip,string wlanacname,string wlanacip)参数说明：返回值：HTTP GET 方式地址：http://portalipaddr:8080/portal/puth/plogin例如：参数：versions=string&username=string&password=string&wlanuserip=string&wlanacname=string&wlanacip= string返回值：{"versions":"1.1","errorCode":"0"}3.1.2 plogoff方法功能描述：用户退出、下线函数声明：string plogoff(string versions,string username,string wlanuserip,string wlanacname,string wlanacip) 参数说明：返回值：HTTP GET 方式地址：http://portalipaddr:8080/portal/puth/plogoff例如：参数：versions=string&username=string&wlanuserip=string&wlanacname=string&wlanacip=string 返回值：{"versions":"1.1","errorCode":"0"}。
接口描述
queryCarQuoteInfoListWS
根据车牌号、车牌底色等查询报价单列表
MDSP01002
报价单查询详细服务
queryCarQuoteInfoDetailsWS
根据报价单号查询报价单详细信息
MDSP01003
报价处理服务
MDSP01004
报价单转投保单服务
MDSP01005
MDSP00002
信息公告查询列表服务
queryMsgListWS
根据员工ID、公告状态等查询公告列表
MDSP00003
信息公告查询详细服务
queryMsgDetailWS
根据公告ID查询公告详细信息
MDSP00004
获取拍照设置服务
MDSP00005
照片上传服务
MDSP00006修改密码服务MFra bibliotekSP01001
交易流水号
header
reqCode
Char(9)
4.1
请求代码
header
reqTime
DateTime
请求时间
header
userCode
用户代码由业务统一管理
员工代码（系统登录名）
header
userId
员工ID（认证成功后返回）
mdsp
body
协议体
body
……
消息内容
1.1.3
父元素名称
元素名称
dateTime
请求时间
header
userCode
用户代码由业务统一管理
员工代码（系统登录名）直接由请求返回
header
userId
员工ID，直接由请求返回
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
不为空
服务 ID
servicename
String
不为空 服务注册名称，英文且不能有空格
servicefullname String
不为空
服务显示名称
servicetype
String
不为空
注册服务类型，本地服务、远程ce、
Geocode Service、Geodata
2 用户管理 ......................................................................................................................... 24
2.1 用户登录 ................................................................................................................. 24 2.1.1 模块功能 ......................................................................................................... 24 2.1.2 Rest 接口.......................................................................................................... 24
1.4 资源查询 ................................................................................................................. 10 1.4.1 模块功能 ......................................................................................................... 10 1.4.2 Rest 接口.......................................................................................................... 10
dataurl:"metadataurl"},
…
]
}
}
失败，返回失败标识 0，并返回失败的原因。
JSON 格式：{result:0,msg:"msg"}
参数说明：
参数名称
参数类型 是否为空
说明
result
String
不为空
0 失败，1 成功
msg
String
可为空
返回的提示信息
serviceid
String
1.2 查看最新注册服务 ....................................................................................................6 1.2.1 模块功能 ...........................................................................................................6 1.2.2 Rest 接口............................................................................................................7
可为空 服务注册名称，英文且不能有空格
注册服务类型：本地服务 010000、
servicetype String
可为空 远程服务 020000、聚合服务 030000，
可为空
服务功能类型，Map Service、
Geocode Service、Geodata
Service、Geometry Service、
{serviceid:serviceid,servicename:"servicename",servicefullname:"s
ervicefullname",servicetype:"servicetype",functiontype:"functiontype"
,status:"status",ifpublish:"ifpublish",transferurl:"transferurl",meta
1.6 服务注册 ................................................................................................................. 17 1.6.1 服务发布 ......................................................................................................... 17 1.6.2 已发布服务查询 .............................................................................................. 18
functiontype String
可为空
Geoprocess Service、Image Service、Globe Service 和 WMS
Service 、WFS Service 等，代码
由通用代码表维护，例如：01 代表
MAP SERVICE，默认值为 01'
Orderby
String
可为空
1.5 资源申请 ................................................................................................................. 15 1.5.1 资源申请 ......................................................................................................... 15 1.5.2 已申请资源查询 .............................................................................................. 16
Service、Geometry Service、
2.2 用户授权 ................................................................................................................. 24 2.2.1 模块功能 ......................................................................................................... 25 2.2.2 Rest 接口......................................................................................................... 25
3 首页 ................................................................................................................................. 24
3.1 模块功能 ................................................................................................................. 27 3.2 REST 接口.................................................................................................................. 27 4 进度计划 ............................................................................................. 错误!未定义书签。
1 地图资源
1.1 主页面
1.1.1 地图预览
1.1.1.1 模块功能 通过 JS API 实现地图预览效果。
1.1.1.2 Rest 接口 该功能不需要 Rest 接口。
1.1.2 查看详情
1.1.2.1 模块功能 该功能类似于服务查询，会查询出该服务的详细信息如服务名称，
元数据信息，REST 访问地址等。
排序类型：1、按服务名称正序排序。 2、按更新时间倒序排序，可为空
返回数据：成功，返回成功标识 1。返回服务 ID，服务名称，服务类型（显
示名称），服务功能类型（显示名称），服务状态，权限状态，服务访问地址，元
数据访问地址。
JSON:{result:1,data:{
userid:userid,services:[
1.1.2.2 Rest 接口
调用运维系统的服务查询接口和查询服务元数据接口，获取返回数据。