接口说明文档
接口文档样例模板
接口文档样例模板一、接口概述:本文档是针对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.2 读者对象本文档适用于软件开发团队、测试人员和其他与系统开发和集成相关的人员。
2.系统概述2.1 系统描述系统为一个类型的软件系统,主要功能包括但不限于、和。
2.2 系统架构系统采用了架构,主要包括以下模块和组件:- 模块1:描述模块1的功能和接口- 模块2:描述模块2的功能和接口-3.接口设计3.1 接口概述系统的接口主要分为内部接口和外部接口,用于不同模块之间的通信和数据传递。
3.2 内部接口3.2.1 模块1接口模块1提供以下接口供其他模块使用:- 接口1:描述接口1的功能和输入输出参数- 接口2:描述接口2的功能和输入输出参数-3.2.2 模块2接口模块2提供以下接口供其他模块使用:- 接口1:描述接口1的功能和输入输出参数- 接口2:描述接口2的功能和输入输出参数-3.3 外部接口3.3.1 数据输入接口系统支持以下数据输入接口:- 接口1:描述接口1的功能和输入参数格式- 接口2:描述接口2的功能和输入参数格式-3.3.2 数据输出接口系统支持以下数据输出接口:- 接口1:描述接口1的功能和输出数据格式- 接口2:描述接口2的功能和输出数据格式-4.接口标准4.1 接口命名规范- 内部接口:采用驼峰命名法,例如getUserName()- 外部接口:采用大写字母和下划线的形式,例如GET_USER_INFO4.2 接口参数规范- 参数类型:根据具体需求确定参数的类型,例如字符串、整数等- 参数命名:采用有意义的命名,易于理解和使用4.3 接口返回值规范- 返回值类型:根据具体需求确定返回值的类型,例如字符串、整数等- 返回值说明:对返回值的含义和可能取值进行详细说明5.附件本文档涉及的附件包括:- 附件1:x- 附件2:x-6.法律名词及注释6.1 法律名词1:定义1- 注释1:x6.2 法律名词2:定义2- 注释2:x7.全文结束。
api接口说明文档模板文
api接口说明文档模板文api接口说明文档模板1正如在"什么是API"中所说,API函数包含在位于系统目录下的DLL文件中.你可以自己输入API函数的声明,但VB提供了一种更简单的方法,即使用API Text Viewer. 要想在你的工程中声明API函数,只需运行API Text Viewer,打开Win32api.txt(或.MDB如果你已经把它转换成了数据库的话,这样可以加快速度. 使用预定义的常量和类型也是同样的方法. API除了有应用“应用程序接口”的意思外,还特指 API的说明文档,也称为帮助文档。
你将会遇到一些问题假设你想在你的窗体模块中声明一个函数.粘贴然后运行,VB会告诉你:编译错误...Declare 语句不允许作为类或对象模块中的 Public 成员...看起来很糟糕,其实你需要做的只是在声明前面添加一个Private(如 Private Declare Function...).--不要忘了,可是这将使该函数只在该窗体模块可用. 在有些情况下,你会得到"不明确的名称"这样的提示,这是因为函数.常量或其他的什么东西共用了一个名称.由于绝大多数的函数(也可能是全部,我没有验证过)都进行了别名化,亦即意味着你可以通过Alias子句使用其它的而不是他们原有的名称,你只需简单地改变一下函数名称而它仍然可以正常运行.api接口说明文档模板文21、技术优势具有高效率、团结、富有创意的团队,技术实力雄厚,可针对不同层次客户的需求;2、服务优势领先的技术、严密的流程、品牌的保证,为在线交易给予有力的安全保障;庞大的客服体系,为您提供7×24小时不间断的客户服务;3、卡类兑换优势解决客户往返银行汇款的麻烦,提升客户效率,有效增加订单数量。
百汇通具有几十种的卡类兑换方式,与上游运营商合作密切,有大部分运营商充值接口,卡类产品的多样化能够满足所有客户的对于卡类兑换的需求。
4PX API接口参数说明文档
4PX物流接口参数说明深圳递四方速递2012-06版本信息目录版本信息 (2)1.概述 (4)1.1.写作目的 (4)1.2.本文读者 (4)1.3.调用方式 (4)1.API 接口参数 (5)1.1.创建订单 (5)1.2.预报订单 (9)1.3.创建并预报订单 (11)1.4.修改订单 (15)1.5.删除订单 (19)1.6.查询订单 (21)1.7.运费试算 (25)1.8.查询轨迹 (28)1.9.申请拦截 (30)1.10.查询跟踪号 (32)1.概述1.1.写作目的本文档是4PX提供的物流接口参数说明,以供开发人员和测试人员参考。
1.2.本文读者本文主要读者为开发员和测试员。
1.3.调用方式1.3.1.W SDL在线订单操作Sandbox::8090/OrderOnline/ws/OrderOnlineService.dll?wsdl 在线订单工具Sandbox::8090/OrderOnlineTool/ws/OrderOnlineToolService.dl l?wsdl1.3.2.S DK4PX提供的SDK调用方式,封装了我司API接口。
1.3.3.测试环境网站URL : :8094/可以通过该网站看到测试环境API上传的订单情况.注:无论是WSDL或者SDK调用方式,如要上线,必需向我司申请正式WSDL或SDK。
1.API 接口参数1.1.创建订单类型: 在线订单操作接口名称:createOrderService1.1.1.请求参数1.1.2.返回参数1.2.预报订单类型: 在线订单操作接口名称:preAlertOrderService 1.2.1.请求参数1.2.2.返回参数1.3.创建并预报订单类型: 在线订单操作接口名称:createAndPreAlertOrderService 1.3.1.请求参数1.3.2.返回参数1.4.修改订单类型: 在线订单操作接口名称:modifyOrderService 1.4.1.请求参数1.4.2.返回参数1.5.删除订单类型: 在线订单操作接口名称:removeOrderService 1.5.1.请求参数1.5.2.返回参数1.6.查询订单类型: 在线订单操作接口名称:findOrderService 1.6.1.请求参数1.6.2.返回参数1.7.运费试算类型: 在线订单工具接口名称:chargeCalculateService1.7.1.请求参数1.7.2.返回参数1.8.查询轨迹类型: 在线订单工具接口名称:cargoTrackingService 1.8.1.请求参数1.8.2.返回参数1.9.申请拦截类型: 在线订单工具接口名称:cargoHoldService1.9.1.请求参数1.9.2.返回参数1.10.查询跟踪号类型: 在线订单工具接口名称:findTrackingNumberService 1.10.1.请求参数1.10.2.返回参数。
java接口文档说明 范例
java接口文档说明范例摘要:1.Java 接口文档的概述2.Java 接口文档的组成部分3.Java 接口文档的编写规范4.Java 接口文档的范例正文:【Java 接口文档的概述】Java 接口文档是描述Java 接口的详细信息的文档,它包括接口的定义、方法、属性以及异常信息等。
Java 接口文档对于开发者来说非常重要,因为它可以提供清晰的接口使用指南,帮助开发者快速地了解和掌握接口的使用方法。
【Java 接口文档的组成部分】一个完整的Java 接口文档通常由以下几个部分组成:1.接口定义:包括接口名、继承关系、实现接口所需的权限等信息。
2.接口描述:对接口的功能和用途进行简要说明。
3.方法说明:对方法进行详细描述,包括方法名、返回类型、参数列表、异常信息等。
4.属性说明:对接口中的属性进行详细描述,包括属性名、类型、默认值等。
【Java 接口文档的编写规范】在编写Java 接口文档时,需要遵循以下规范:1.使用正确的文档标签:Java 接口文档使用`/**`开始,以`*/`结束。
2.保持文档的简洁明了:避免使用过于复杂的句子,尽量用简单明了的语言描述接口。
3.保持文档的一致性:在描述接口的各个部分时,要保持风格的一致性,以便于阅读。
4.提供详细的信息:在描述接口时,应尽可能地提供详细的信息,包括方法的返回值、参数的类型等。
【Java 接口文档的范例】下面是一个Java 接口文档的范例:```java/*** 这是一个示例接口,用于演示接口文档的编写。
* 该接口提供了一个简单的计算功能,可以执行加法和减法运算。
接口文档范例示意
接口文档范例示意文章标题:接口文档范例示意 - 简单易懂的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 公共响应参数公共响应参数是指在每个接口的响应结果中都会返回的参数,例如状态码、错误信息等。
在该部分中,列举出每个公共响应参数的名称、类型和描述。
API接口文档
tagParam[i] = t;}int i = PushManager.getInstance().setTag(context,tagParam, System.currentTimeMillis() +"");String text = "设置标签失败,未知异常";switch (i) {case PushConsts.SETTAG_SUCCESS:text = "设置标签成功";break;case PushConsts.SETTAG_ERROR_COUNT:text = "设置标签失败, tag数量量过⼤大, 最⼤大不不能超过200个"; break;case PushConsts.SETTAG_ERROR_FREQUENCY:text = "设置标签失败, 频率过快, 两次间隔应⼤大于1s";break;case PushConsts.SETTAG_ERROR_REPEAT:text = "设置标签失败, 标签重复";break;case PushConsts.SETTAG_ERROR_UNBIND:text = "设置标签失败, 服务未初始化成功";break;case PushConsts.SETTAG_ERROR_EXCEPTION:text = "设置标签失败, 未知异常";break;case PushConsts.SETTAG_ERROR_NULL:text = "设置标签失败, tag 为空";break;case PushConsts.SETTAG_NOTONLINE:text = "还未登陆成功";break;case PushConsts.SETTAG_IN_BLACKLIST:text = "该应⽤用已经在⿊黑名单中,请联系售后⽀支持!";break;case PushConsts.SETTAG_NUM_EXCEED:text = "已存 tag 超过限制";break;。
接口文档模板范文
接口文档模板范文一、接口概述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. 引言接口文档是软件开发中非常重要的一部分,它定义了系统与外部系统或组件之间的通信接口。
本文档旨在提供一个接口文档范文,以便开发人员编写规范的接口文档,确保系统能够与其他系统或组件正确地交互。
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状态码规范进行错误处理。
萤石平台接口使用说明文档
描述 协议版本号 签名值 开放平台appkey值 UTC时间戳,自1970年1月1日起计算的时间,单位为秒 HTTP请求执行方法
HTTP方法使用的参数集合
请求消息id号,同步调用时传入任意整数值
system:系统参数集合
ver:协议版本信息,当前为1.0 sign:签名值,服务端用来做签名校验 key:appkey在萤石云开放平台()注册申请后由萤石云平台统一颁布, 与之匹配的secret值用来做签名校验。针对于每一个应用,都需要在萤石云平台上申请自 己使用的appkey及secret time:请求时私有云的时间戳(UTC),私有云要与萤石开平同步时间(两者时间不能相差超 过5分钟)。如果私有云时间与萤石开平的时间相差超过5分钟,将会返回10010错误码。
参数为空或者格式不对
确认appKey状态,不通过或者冻结状态会 返回该错误码
①获取签名方式详见apidemo ②注意编码格 式为UTF-8
参照绑定流程
5
Introduction
20001 20002 20003 20004 20005 20006 20007 20008 20009 20010 20012 20013 20014 20015 20016 20017 20018 20019 20020 20021
3.1.3 实现范例
请求:
isEncrypt defence
Y
是否加密,0:不加密, 1:加密
布撤防状态(0:撤防;1:布
防;2:不支持;4:pir开启;
Y
8:athome布防;16:outdoor 布防;NULL:设备没有上报
(完整版)接口说明文档
1.1.1.1接口功能
客户端检测服务端是否可达.
接口采用webservice技术。当客户端需要连接服务端并确保连接可达时,将通过webservice的方式向服务器发送检测请求,服务端响应客户端的请求,把处理结果返回给客户端。
接口调用方法为http://url/isServerAvailable.
String
32
timestamp
时间戳,用于防重放攻击
String
18
1.1.1.3应答参数
接口参数说明如下:
名称
说明
数据类型
长度(字节)
result
结果:
1:成功
-1:失败
-2:参数错误
—3:hashCode错误
Int
1
info
返回结果的说明,该字段可选
String
128
hashCode
把所有的简单类型的字段按顺序组合后+key计算md5
方法名:isServerAvailable
1.1.1.2请求参数
包含的参数说明如下:
名称
说明
数据类型
长度(字节)
loginName
接口验证账号
String
30
loginPwd
接口验证密码
String
30
hashCode
除loginName,loginPwd,hashCode外的所有字段+Key 组合后计算md5
String
32
timestamp
时间戳,用于防重放攻击
String
18
接口文档范文
接口文档范文一、概述接口文档是用来描述软件系统接口的一种文档,它详细说明了系统中各个接口的功能、参数、调用方法等。
接口文档是开发人员进行开发和集成的重要参考资料,也是不同系统之间进行数据交互的重要依据。
本文将以一个示例接口文档为范本,详细介绍接口文档的内容和编写要求。
二、接口名称接口名称:用户注册接口三、接口描述该接口用于用户注册功能,用户可以通过该接口完成账号的注册。
四、接口地址接口地址:/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结论接口文档是软件开发过程中必不可少的一部分,它起到了明确各个接口的功能和使用方法的作用。
本文以一个用户注册接口为例,详细介绍了接口文档的内容和编写要求。
在实际编写接口文档时,需要确保内容准确严谨,避免歧义或错误信息的出现。
同时,良好的结构和清晰的语言描述也是编写接口文档的重要要求。
接口文档说明示例
支付网关说明文档by:Q294500001目录##联盟支付网关说明文档........................................................................ 错误!未定义书签。
目录 .. (1)第一章文档描述.............................................................................................. 错误!未定义书签。
1、文档说明 (1)2、阅读对象 (1)第二章系统原理 (2)1、术语定义 (2)2、消费流程 (2)3、查询流程 (2)4、系统加密 (2)第三章网银接口定义 (3)1、同步过程接口定义(商户系统发起请求) (3)2、下行异步通知过程接口定义(##联盟接口发起请求) (5)3、下行同步通知过程接口定义(##联盟接口发起请求) (7)第四章查询流程接口定义 (8)第五章订单外部查询独立网址...................................................................... 错误!未定义书签。
附录1:##联盟支付网关银行类型说明. (9)第一章文档描述1、文档说明本说明文档用于指导##联盟商户实现与##联盟网银接口的顺利对接。
请相关技术人员详细阅读本文档。
2、阅读对象商户开发人员。
第二章系统原理1、术语定义商户:指已独立拥有在线销售系统,并成为##联盟网银接口系统会员,且已使用或者将使用##联盟网银接口实现收付费或其他相关功能需求的企业或者个人。
外部接入接口:指##联盟通过统一的方式接受外部请求的接口。
商户系统:指使用##联盟外部接入接口的计算机系统,一般指商户所拥有的在线销售系统。
用户:指在商户系统内进行消费的企业或者个人。
商户ID:指##联盟为使用外部接入接口的商户统一分配的唯一标识。
西部数码API接口说明文档v2.0说明书
西部数码A P I接口说明文档The documentation of WEST263 API(Application Programming Interface)版本号:v2.0作者: 西部数码发行日期:2015/1/25命令索引目录上传域名实名认证文件 (5)1.API接口地址 (7)2.参数说明 (7)2.1公共参数 (7)一、虚拟主机相关 (9)1.1开通正式/试用虚拟主机 (9)1.2修改FTP密码 (10)1.3主机续费 (10)1.4试用主机转正 (11)1.5主机升级 (11)1.6获取FTP密码 (12)1.7判断FTP是否使用 (13)1.8获取主机相关信息 (13)1.9虚拟主机绑定域名 (15)2.10删除绑定域名 (15)2.11虚拟主机流量充值 (16)2.22开通赠送MYSQL数据库 (16)二、域名相关接口 (17)2.1注册域名 (17)2.2修改域名密码 (20)2.3续费域名 (21)2.4开通URL转发 (21)2.5域名查询接口 (22)2.6添加域名解析记录 (22)2.7修改域名解析记录 (23)2.8删除域名解析记录 (24)2.9列举域名解析记录 (24)2.10提交域名转入 (25)2.11查询域名转入状态 (26)2.12修改域名DNS (27)2.13获取域名信息 (28)2.14上传域名实名认证文件 (29)2.15获取CN域名上传状态 (31)2.16获取域名资料上传状态 (32)三、数据库相关接口 (32)3.1开通赠送数据库 (32)3.2开通正式的数据库 (33)3.3修改数据库密码 (34)3.4续费数据库 (35)3.5试用转正 (35)四、邮局相关接口 (37)4.1开通收费/试用邮局 (37)4.2修改邮局密码 (37)4.3邮局续费 (38)五、其他功能 (39)5.1获取产品对应的机房列表 (39)5.2获取产品列表 (39)5.3获取FTP密码 (40)5.4获取邮局密码 (41)5.5获取数据库密码 (41)5.6获取可用金额 (42)5.7获取域名密码 (42)5.8升级企业邮局 (43)5.9升级数据库 (44)5.10申请发票 (44)5.11试用邮局转正 (45)5.12虚拟主机业务同步 (46)5.13域名业务同步 (48)5.14企业邮局业务同步 (49)5.15数据库业务同步 (50)5.16同步所有业务的密码 (51)5.17接口测试 (52)5.18获取成本价 (52)5.19获取虚拟主机产品的操作系统列表 (53)5.20获取业务到期时间 (54)5.21判断FTP是否存在 (54)5.22获取所有产品赠品信息 (55)5.23提交有问必答 (56)5.24获取有问必答内容 (57)5.25获取产品价格(域名,虚拟主机,邮局) (58)5.26获取VPS机房价格 (58)5.27获取VPS服务器机房参数 (59)5.28获取主站业务开通日志 (60)六、套餐云主机、VPS相关 (60)6.1云主机添加 (60)6.2主机续费 (63)6.3变更基本信息 (63)6.4主机升级 (64)七、其他函数 (66)7.1获取VPS或套餐云的机房信息 (66)7.2获取主机升级参数 (66)7.3查询虚拟主机购买的独立IP (68)八、弹性云主机 (70)8.1购买弹性云主机 (70)8.2弹性云主机升级 (72)8.3弹性云主机转正 (73)8.4云主机续费 (74)8.5变更云主机的附加信息(可选功能) (74)8.6弹性云主机重启、开机、关机 (75)8.7弹性云主机的状态变化 (76)8.8弹性云备份操作 (76)8.9弹性更换线路 (77)8.10获取白名单列表 (78)8.12删除白名单 (79)8.13重装系统 (79)8.14购买IP (80)8.15获取主机相关信息 (81)8.16添加工单 (82)8.17获取工单服务列表 (83)8.18获取有问必答回复 (84)8.19修改操作系统管理员密码 (84)8.20获取性能数据 (85)8.21修改独立控制面板密码 (86)版本变更说明修改日期版本号修改说明2008-1-1 1.3西部数码发布第一版api接口:/CustomerCenter/doc/west263-API.doc2013-7-26 2.02.0新版api接口发布,采用新的接口地址,格式跟老版本不兼容。
接口设计说明IDD文档标准模版
接口设计说明(IDD)XXXX公司文件版本V1.0XXXX接口设计说明(IDD)版本/更改状态1/0文件更改记录^件版本变更记录接口设计说明(IDD)说明:1.《接口设计说明》(IDD)描述了一个或多个系统或子系统、硬件配置项HWCI、计算机软件配置项CSCI、手工操作或其他系统部件的接口特性。
一个IDD可以说明任何数量的接口。
2.IDD可用于补充《系统/子系统设计(结构设计)说明》(SSDD)、《软件(结构)设计说明》(SDD)和《数据库(顶层)设计说明》(DBDD)。
IDD及其相伴的《接口需求规格说明》(IRS)用于沟通和控制接口的设计决策。
模版说明:1、文档字体设定:标题1:小一标题2:二号标题3:小二标题4:三号标题5:小三标题6:四号正文:四号2、文章编号,请使用格式刷刷,不要手工编号。
目前格式都是对的。
3、内容根据实际情况裁剪,一般可行性研究报告,模版章节不可缺。
4、封面图片请根据实际情况自行替换。
5、关于修订记录,请根据文档需要自行添加。
1.引言本章分为以下几条。
1.1.标识本条应包含本文档适用的系统、接口实体和接口的完整标识,(若适用)包括标识号、标题、缩略词语、版本号、发行号。
1.2.系统概述本条应简述本文档适用的系统和软件的用途。
它应描述系统与软件的一般性质;概述系统开发、运行和维护的历史;标识项目的投资方、需方、用户、开发方和支持机构;标识当前和计划的运行现场;并列出其他有关文档。
1.3.文档概述本条应概括本文档的用途与内容,并描述与其使用有关的保密性或私密性要求。
1.4.基线说明编写本系统设计说明书所依据的设计基线。
2.引用文件本章应列出本文档引用的所有文档的编号、标题、修订版本和日期。
本章也应标识不能通过正常的供货渠道获得的所有文档的来源。
3.接口设计本章应分条描述一个或多个系统、子系统、配置项、手工操作和其他系统部件的接口特性。
如果设计的部分或全部依赖于系统状态或方式,则应指出这种依赖性。
快递鸟接口技术文档说明书
快递鸟接口(API)技术文档1前言 (5)2接口规范说明 (5)2.1接口规范及说明 (5)2.1.1报文及报文编码 (5)2.1.2接口数据包结构 (5)2.1.3JSON示例 (6)2.1.4系统级参数 (6)2.1.5流程示意图 (7)2.2签名说明 (7)2.2.1关于签名 (7)2.2.2(C#)DataSign签名加密代码 (9)3下单类接口 (10)3.1接入步骤 (10)3.2预约取件接口 (11)3.2.1功能说明 (11)3.2.2基本信息 (11)3.2.3接口规则 (12)3.2.4支持情况 (12)3.2.5应用级参数 (12)3.2.6返回参数 (17)3.3预约取件取消接口 (17)3.3.1功能说明 (17)3.3.2基本信息 (17)3.3.3接口规则 (18)3.3.4支持情况 (18)3.3.5应用场景 (18)3.3.6应用级参数 (18)3.3.7返回参数 (19)3.4电子面单接口 (19)3.4.1功能说明 (19)3.4.2基本信息 (19)3.4.3应用场景 (20)3.4.4接口规则 (20)3.4.6应用场景 (21)3.4.7应用级参数 (21)3.4.8返回参数 (30)3.5电子面单取消接口 (35)3.5.1功能说明 (35)3.5.2基本信息 (36)3.5.3接口规则 (36)3.5.4支持情况 (36)3.5.5应用级参数 (36)3.5.6返回参数 (37)3.6电子面单追加子单接口 (37)3.6.1功能说明 (37)3.6.2基本信息 (37)3.6.3应用级参数 (38)3.6.4返回参数 (38)3.7获取电子面单文件接口 (39)3.7.1功能说明 (39)3.7.2基本信息 (39)3.7.3应用级参数 (39)3.7.4返回参数 (40)4轨迹查询类接口 (42)4.1即时查询接口 (42)4.1.1功能说明 (42)4.1.2基本信息 (42)4.1.3接口规则 (42)4.1.4支持情况 (42)4.1.5应用场景 (42)4.1.6应用级参数 (42)4.1.7返回参数 (43)4.2物流跟踪 (45)4.2.1轨迹订阅接口 (45)4.3单号识别接口 (64)4.3.1功能说明 (64)4.3.2基本信息 (64)4.3.3接口规则 (64)4.3.4应用级参数 (64)4.3.5返回参数 (65)5增值类接口 (66)5.1在途监控-国内版 (66)5.1.1即时查询接口(增值版) (66)5.1.2物流跟踪接口(增值版) (72)5.2快递查询接口 (78)5.2.1功能说明 (78)5.2.2基本信息 (78)5.2.3接口规则 (78)5.2.4支持情况 (78)5.2.5应用场景 (78)5.2.6应用级参数 (78)5.2.7返回参数 (79)5.3在途监控-国际版 (84)5.3.1物流跟踪接口(国际版) (84)5.4物流查询地图接口 (86)5.4.1即时查询接口(地图版) (87)5.4.2物流跟踪接口(地图版) (95)5.5短信服务 (100)5.5.1短信模板接口 (101)5.5.2短信发送接口 (103)5.5.3短信黑名单接口 (105)5.6智能地址解析接口 (106)5.6.1功能说明 (106)5.6.2基本信息 (106)5.6.3应用级参数 (106)5.6.4返回参数 (107)6附录 (109)6.1对接相关资料 (109)6.2电子面单模板规格 (109)6.3返回编码列表 (116)7技术支持 (117)1前言快递鸟API旨在为电商、电商平台、物流工具、打单工具、仓储系统、移动APP等系统提供专业、稳定、优质的API接口服务,满足不同用户的物流管理需求。
接口文档
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)不利用本软件制作、复制、发布、传播含有下列内容的信息:✧反对宪法所确定的基本原则的;✧危害国家安全,泄露国家秘密,颠覆国家政权,破坏国家统一的;✧损坏国家荣誉和利益的;✧煽动民族仇恨、民族歧视,破坏民族团结的;✧破坏国家民族宗教政策,宣扬邪教和封建迷信的;✧散布谣言,扰乱社会秩序,破坏社会稳定的;✧散布淫秽、色情、赌博、暴力、凶杀、恐怖或者教唆犯罪的;✧侮辱或者诽谤他人,侵害他人合法权益的;✧含有法律、行政法规禁止的其他内容的;(6)自信息发布六个月内不修改删除信息发送日志内容,日志记录的备份应至少保持6个月以上,在国家机关进行依法查询时,予以提供。
(完整版)接口文档样例模板.doc
项目名称
项目信息(接口模块名称)
功能描述:
【获取项目基本信息(整个项目信息模块的接口功能描述)】
返回说明:(统一的接口返回方式)
参数名称类型描述
Code String 状态码:
200 成功
404 错误Msg String 信息描述Data 返回的数据
1.获取项目基本信息(/v1/project/get)
【对标题接口必须有序号,方便后期的维护和修改跟进】【接口功能描述】
1.1 、请求协议(https)
1.2 、请求方式(
1.3 、输入参数:
字段中文名
项目 ID GET)
英文名类型是否必填业务补充描述Project_id bigint Y
1.4 、返回信息:
字段中文名英文名类型业务补充描述项目 ID Id
楼盘 Code f_house_code
项目名prj_name
标签prj_tags
开发商developers
销售状态project_sale
经纬度project_location
project_sale 返回信息
字段中文名英文名类型业务补充描述
销售状态sale_status 在售、待售、售
完
project_location
字段中文名英文名类型业务补充描述
经度longitude
纬度latitude
1.5 、业务返回规则要求(业务方面的返回要求,比如查询结果按照时间排序之类的)
1、查询结果按照创建时间排序显示。
rabbitmq-c接口参数说明文档精选全文
rabbitmq-c接⼝参数说明⽂档关于rabbitmq-c消息队列接⼝参数发布端amqp_new_connection()声明⼀个新的 amqp_connection,简称为 connamqp_tcp_socket_new(conn)创建⼀个 TCP socket:conn 为先前声明的 amqp_conneciton,函数返回值记为 socketamqp_socket_open(socket, hostname, port)打开 TCP socket,获取 socket 值为 status。
其中:socket — 为先前创建的 TCP;hostname — 为rabbitmq server 主机;port — 为其监听端⼝amqp_login(amqp_connection_state_t state, char const vhost, int channel_max, int frame_max, int heartbeat, int sasl_method, …)⽤于登录rabbitmq sever,主要⽤于进⾏权限管理:state — 如前⽂ conn(amqp_connection);vhost — 虚拟主机;chnnel_max — 最⼤连接数;frame_max — 和客户端通信时允许的最⼤帧数, 默认值131072(↑提⾼吞吐,↓降低时延);heartbeat — ⼼跳帧,两次⼼跳间的秒数,heartbeat超时值定义了RabbitMQ及其client库在多久之后认为TCP连接不可到达。
默认为0;sasl_method — SSL认证;amqp_channel_open(amqp_connection_state_t state, amqp_channel_t channel)⽤于关联 conn 和 channel:state — conn(amqp_connection);channel — 进⾏RPC的通道;amqp_basic_publish( amqp_connection_state_t state, amqp_channel_t channel, amqp_bytes_t exchange,amqp_bytes_t routing_key, amqp_boolean_t mandatory, amqp_boolean_t immediate, structamqp_basic_properties_t_ const properties, amqp_bytes_t body)发布消息到代理(通过 routing key 发布消息到 exchange 上):state — conn;channel — 通道标识符;exchange — 代理上被发布消息的 exchange;routing_key — 发布消息时需要使⽤的路由密匙;mandatory — 此标志指⽰服务器如果⽆法将消息路由到队列,该如何反应。
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
1.1.1.1接口功能
客户端检测服务端是否可达。
接口采用webservice技术。当客户端需要连接服务端并确保连接可达时,将通过webservice的方式向服务器发送检测请求,服务端响应客户端的请求,把处理结果返回给客户端。
接口调用方法为http://url/isServerAvailable。
String
32
timestamp
时间戳,用于防重放攻击
String
18
String
32
timestamp
时间戳,用于防重放攻击
String
18
1.1.1.3应答参数
接口参数说明如下:
名称
说明
数据类型
长度(字节)
result
结果:
1:成功
-1:失败
-2:参数错误
-3:hashCode错误
Int
1
info
返回结果的说明,该字段可选
String
128
hashCode
把所有的简单类型的字段按顺序组合后+key计算md5
方法名:isServerAvailable
1.1.1.2请求参数
包含的参数说明如下:
ቤተ መጻሕፍቲ ባይዱ名称
说明
数据类型
长度(字节)
loginName
接口验证账号
String
30
loginPwd
接口验证密码
String
30
hashCode
除loginName,loginPwd,hashCode外的所有字段+Key 组合后计算md5