网络接口文档参考
通用接口标准规范v1
通⽤接⼝标准规范v1…接⼝标准规范⽬录接⼝标准规范 (1)第1章概述 (3)第2章基本要求 (4)信息通讯安全 (4)；安全评估 (4)访问控制 (4)防恶意代码 (4)加密 (5)⽀持⾼并发 (6)可监控 (6)⽇志全覆盖 (6)系统资源的动态扩展 (6)，异常处理机制 (7)业务扩展 (7)第3章接⼝通讯⽅式 (7)同步请求/应答⽅式 (7)异步请求/应答⽅式 (7)会话⽅式 (7)⼴播通知⽅式 (7)事件订阅⽅式 (7)·⽂件传输 (8)可靠消息传输 (8)第4章传输控制要求 (8)负载均衡 (8)伸缩性与动态配置管理 (8)⽹络调度 (9)充分理由 (9)单⼀职责 (9))⾼内聚低耦合 (9)状态及消息 (10)控制数据量 (10)禁⽌随意拓展参数 (10)第5章接⼝技术 (10)第6章接⼝规范 (11)域名规范 (11)http接⼝ (11)…webservice接⼝ (11) API路径规范 (11)http接⼝ (11) webservice接⼝ (11)版本控制规范 (12)http接⼝ (12) webservice接⼝ (12) API命名规范 (12)~新增⽅法 (13)删除⽅法 (13)修改⽅法 (13)获取⽅法 (13)获取列表⽅法 (13)请求参数规范 (14)参数需要命名规则 (14)请求参数加密⽅法 (14) `列表请求特殊规范 (15)返回数据规范 (15)第7章接⼝⽂档规范 (16)第8章接⼝管理 (16)对接⼝分类、编码排序。
(16)在线⽂档。
(16)…$第1章概述本⽂主要为了明确标准和规范，为服务使⽤⽅和服务提供⽅提供开发参考。
/第2章基本要求为了保证系统的完整性和健壮性，系统接⼝应满⾜下列基本要求：2.1信息通讯安全2.1.1安全评估保证接⼝的⾃⾝安全，通过接⼝实现技术上的安全控制，做到对安全事件的“可知、可控、可预测”，是实现系统安全的⼀个重要基础。
28335接口扩展 (XINTF) 参考指南
TMS320x2833x,2823xDSC接口扩展 (XINTF)参考指南文献编号:SPRU949DSeptember2007–Revised January 2010前言 (5)1 功能描述 (7)1.1与TMS320x281x XINTF的区别 (7)1.2与TMS320x2834x XINTF的区别 (8)1.3访问XINTF空间 (8)1.4写操作紧跟读操作的流水线保护 (9)2 XINTF功能配置 (10)2.1外部接口(XINTF)配置寄存器及时序寄存器的设置 (10)2.2XINTF时钟 (11)2.3写缓存 (12)2.4每个XINTF区域的访问建立/激活/跟踪状态的定时 (12)2.5对每个区采样XREADY (13)2.6储体转接 (13)2.7区数据总线宽度 (14)3 外部DMA支持(XHOLD,XHOLDA) (16)4 建立，激活及跟踪状态的配置 (17)4.1忽略USEREADY信号 (17)4.2同步模式(USEREADY=1,READYMODE=0) (18)4.3异步模式(USEREADY=1,READYMODE=1) (18)5配置XBANK 周期 (22)6 XINTF 寄存器 (23)6.1 XINTF定时寄存器 (23)6.2 XINTF配置寄存器 (27)6.3 XBANK寄存器 (29)6.4 XREVISION寄存器 (29)6.5 XRESET寄存器 (29)7信号说明 (31)8波形 (32)附录A修订历史记录 (37)图目录1 外部接口框图 (9)2 访问流程图 (11)3 XTIMCLK和SYSCLKOUT之间的关系 (12)4 XINTF 典型16位数据总线连接 (14)5 XINTF 典型32位数据总线连接 (15)6 XTIMING0/6/7寄存器分布 (23)7 XINTF配置寄存器(XINTCNF2) (27)8 XBANK寄存器 (29)9 XREVISION寄存器 (29)10 XRESET寄存器 (30)11 XTIMCLK和XCLKOUT模式波形 (33)12 通用读周期(XTIMCLK=SYSCLKOUT模式) (34)13 通用读周期(XTIMCLK=½SYSCLKOUT模式) (35)14 通用写周期(XTIMCLK=SYSCLKOUT模式) (36)表目录1 16位模式性能 (15)2 32位模式性能 (15)3 依据XTIMCLK周期的持续脉冲 (17)4 Lead/Trail 数值与XTIMCLK/X2TIMING方式之间的关系 (20)5 Active数值与XTIMCLK/X2TIMING方式之间的关系 (21)6 有效XBANK配置 (22)7 XINTF配置和控制寄存器映射 (23)8 XTIMING0/6/7寄存器字段说明 (23)9 XINTF配置寄存器字段说明 (27)10 XBANK寄存器字段说明 (29)11 XREVISION寄存器字段说明 (29)12 XRESET寄存器字段说明 (30)13 XINTF信号说明 (31)14 修订 (37)前言本文档介绍了在F2833x或F2823x设备中使用的外部接口（XINTF）。
固话宽带API接口文档
固话宽带API接口1.21.接口说明1.1参数格式参数格式采用JSON数据格式传递1.2接口返回数据格式返回数据格式采用JSON数据格式1.3网络安全绑定IP，只有授权ip才可访问此接口1.4处理时限处理时限为130秒，若130秒没有结果返回则说明处理失败1.5接口类型采用所有语言通用的Webservice2.传递参数详细说明2.2公共输出参数名类型备注success boolean true：成功，false：失败msg String提示信息2.3查询接口输入：参数名类型备注junit String收费单位param1String号码param2String缴费月份等param3Stringparam4String预留参数，可以为空输出：参数名类型备注customerName String客户名称balance String余额或缴费金额等belongTo String归属地2.4下单接口输入：参数名类型备注junit String收费单位param1String号码param2String缴费月份等param3Stringparam4String预留参数，可以为空money String缴费金额或价格customerName String客户名称balance String余额或缴费金额等输出：参数名类型备注chargeId String缴费流水号（查订单进度时、撤单时用）2.5订单进度输入：参数名类型备注chargeId String缴费请求流水号（下单时候，接口返回的流水号）输出参数名类型备注status String-1没有此笔流水记录0缴费失败，全额退款1缴费中2缴费成功更多接口文档,访问1、代收水电煤电视API接口文档2、代购火车票API接口文档3、手机充值API接口文档4、代购汽车票API接口文档5、固话宽带API接口文档6、代购飞机票API接口文档7、Q币游戏点卡充值API接口文档。
API接口参考指南(简单版)
API接口参考指南(简单版)概述该文档提供了对API接口的详细参考指南，以帮助开发人员快速了解和使用API接口。
API接口介绍API接口是用于应用程序之间进行通信和交互的一种机制。
通过使用API接口，应用程序可以请求其他应用程序提供的功能和数据，以实现更多的功能。
使用API接口的好处- 提高开发效率：使用API接口可以直接调用其他应用程序的功能，避免重复编写相同的代码。
- 扩展应用功能：能够通过API接口获取其他应用程序的数据，从而扩展自身应用的功能。
- 实现应用集成：通过使用API接口，不同的应用程序可以相互协作，实现更多的集成功能。
API接口的基本使用方法1. 注册访问权限：在开始使用API接口之前，一般需要注册一个开发者账号，并申请访问权限。
2. 获取API接口文档：通过开发者账号获取API接口的详细文档，其中包含接口的请求参数、响应数据等信息。
3. 构建请求URL：根据API接口文档中的要求，构建请求URL，并添加所需的参数。
5. 处理响应：接收到API接口的响应后，根据文档中的响应格式进行解析和处理。
常见的API接口类型1. 通信类API接口：用于网络通信相关功能，如发送短信、邮件、即时通信等。
2. 数据类API接口：用于获取和处理数据相关功能，如获取天气信息、股票行情等。
3. 服务类API接口：用于提供特定服务相关功能，如在线支付、地图导航等。
API接口的注意事项- 遵循API接口文档中的使用规范和限制。
- 确保使用的API接口有稳定可靠的服务器支持。
- 对敏感数据的处理要符合相关的安全和隐私规定。
- 定期更新和升级使用的API接口，以获得最新的功能和性能优化。
结论通过本文档，您可以更加深入地了解API接口的使用方法和好处。
请确保遵循API接口文档中的规范和限制，以实现更高效和安全的应用开发。
接口文档范本
1 引言1．1编写目的说明编写这份详细设计说明书的目的，指出预期的读者。
1．2背景说明：a．待开发软件系统的名称；b．本项目的任务提出者、开发者、用户和运行该程序系统的计算中心。
1．3定义列出本文件中用到专门术语的定义和外文首字母组词的原词组。
1．4参考资料列出有关的参考资料，如：a．本项目的经核准的计划任务书或合同、上级机关的批文；b．属于本项目的其他已发表的文件；c．本文件中各处引用到的文件资料，包括所要用到的软件开发标准。
列出这些文件的标题、文件编号、发表日期和出版单位，说明能够取得这些文件的来源。
2 程序系统的结构用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）的名称、标识符和它们之间的层次结构关系。
3 程序1（标识符）设计说明从本章开始，逐个地给出各个层次中的每个程序的设计考虑。
以下给出的提纲是针对一般情况的。
对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。
3．1程序描述给出对该程序的简要描述，主要说明安排设计本程序的目的意义，并且，还要说明本程序的特点（如是常驻内存还是非常驻？是否子程序？是可重人的还是不可重人的？有无覆盖要求？是顺序处理还是并发处理卜…．．等）。
3．2功能说明该程序应具有的功能，可采用IPO图（即输入一处理一输出图）的形式。
3．3性能说明对该程序的全部性能要求，包括对精度、灵活性和时间特性的要求。
3．4输人项给出对每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。
数量和频度、输入媒体、输入数据的来源和安全保密条件等等。
3．5输出项给出对每一个输出项的特性，包括名称、标识、数据的类型和格式，数据值的有效范围，输出的形式、数量和频度，输出媒体、对输出图形及符号的说明、安全保密条件等等。
3．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接口文档模板，希望开发者在编写接口文档时能够按照该模板进行规范化的操作，以便更好地进行接口的使用和维护。
同时，也希望在实际使用中能够不断完善和优化该模板，使其更符合实际需求。
讯鸟通讯平台接口文档V1（可编辑）
讯鸟通讯平台接口文档V1.22编写人:柳英俊、袁常军、刘彦斐日期:2012-5-22审核人:段志晖、闫研日期:2012-6-10北京讯鸟软件有限公司目录1 引言 11.1 本文目的 11.2 预期读者 11.3 开发适用范围 11.4 术语和缩略语 11.5 相关概念 12 二次开发概述 32.1 基于ocx客户端的二次开发-软电话操作 32.1.1 开发调试环境 32.1.2 座席状态 42.1.3 二次开发参考文档72.2 基于GUI客户端的二次开发282.2.1 二次开发参考文档283 简易流程图523.1 外呼流程523.2 呼入流程533.3 监听流程54变更记录序号版本号变更内容变更原因提出人变更人变更日期1 V1.2 接口的变更功能需求柳英俊刘彦斐2012/5/222 V1.2 隐藏号码追加业务需求张斌刘彦斐2012/5/223 V1.2.1 增加统一登陆,来电弹屏,去电弹屏接口的概要说明,示例场景及示例链接。
增加通讯历史等数据接口的概要说明及示例链接。
(章节2.2.1) 完善接口文档李明阳李明阳2013/05/094 V1.2.2 重新整理了作业接口中的描述结构,并且添加了场景和示例代码。
(章节2.2.1) 完善接口文档李明阳李明阳2013/5/15引言本文目的本文档是启通宝接口的说明书,以作为二次开发的参考文档。
预期读者包括:合作客户、运营、大客户服务部、销售、开发、测试等。
开发适用范围1.基于ocx客户端的二次开发:讯鸟提供AgentPanelOcxocx控件给企业做二次开发。
企业可以在Visual C++C#, Visual Basic, Power Builder, Delphi, ASP, JSP等任何能直接使用ocx的平台中,调用ocx接口方法和事件来实现呼叫中心的呼叫控制以及和服务器进行数据交换。
2.基于GUI客户端的二次开发:讯鸟提供封装的GUI客户端给二次开发商,开发者可以通过启通宝客户端和客户的业务系统整合; 客户也可以通过调用讯鸟启通宝提供的界面接口和数据接口,例如通讯历史、报表、监控和录音调听等接口,来实现客户的定制化开发。
api接口文档
API协议文档（v0.03）目录一、前言 (4)（一）适用范围 (4)（二）定义、专业术语及缩略语 (4)二、协议格式说明 (5)（一）事项申明 (5)（二）请求格式 (5)（三）输出格式及时间、数组的说明 (6)三、协议 (7)●公共接口 (7)1.版本检查 (7)2.设备注册 ................................................................................................................................. 错误！未定义书签。
●B端.......................................................................................................................................... 错误！未定义书签。
3.登录 ......................................................................................................................................... 错误！未定义书签。
4.获取未处理预约数 ................................................................................................................. 错误！未定义书签。
5.获取验证码 ............................................................................................................................. 错误！未定义书签。
接口文档范文
接口文档范文一、概述接口文档是用来描述软件系统接口的一种文档，它详细说明了系统中各个接口的功能、参数、调用方法等。
接口文档是开发人员进行开发和集成的重要参考资料，也是不同系统之间进行数据交互的重要依据。
本文将以一个示例接口文档为范本，详细介绍接口文档的内容和编写要求。
二、接口名称接口名称：用户注册接口三、接口描述该接口用于用户注册功能，用户可以通过该接口完成账号的注册。
四、接口地址接口地址：/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结论接口文档是软件开发过程中必不可少的一部分，它起到了明确各个接口的功能和使用方法的作用。
本文以一个用户注册接口为例，详细介绍了接口文档的内容和编写要求。
在实际编写接口文档时，需要确保内容准确严谨，避免歧义或错误信息的出现。
同时，良好的结构和清晰的语言描述也是编写接口文档的重要要求。
MSP430网络接口设计指南
MSP430网络接口设计指南JY430_NET V1.01开发板使用说明感谢您选用了JY430_NET系列开发板，希望这款开发板能让您如虎添翼。
声明：本文档仅适用于第九单片机开发网的JY430_NET系列开发板这款开发板的概况如下图所示：1.使用 MSP430F149主MCU, 2K RAM, 60kflash, 48个I/O pin, 双uart 口, 8路12位A/D转换2.TCP/IP接口采用工业级CS8900芯片3.带有USB通信接口，适合使用笔记本的朋友进行调试。
4.主电路板带:RS232双工通信接口DB9输出公座;I2C 接口存储器一块（升级为铁电存储器FM24CL16）擦除寿命1亿次;3.3V稳压集成电路采用高稳定度AS1117-3.3数据口P4和所有多余I/O口引出,便于扩展配有高频（HF）和低频(LF)两种晶振，可方便选择各单元电路间有良好去耦合措施,大面积接地技术,电磁兼容性能良好5.具有板载硬件实时钟PCF8563，并搭配电池，满足特定应用需要。
6.配备了硬件外置看门狗芯片MAX706，使得这个开发板可以长期进行稳定的使用，也可以直接作为产品板用于设备当中。
开发板供电采用了外界电源方式，使用+5V直流电源输入。
为了维持稳定性，USB部分不作为供电输入。
网络部分的+3.3V供电和232、USB接口部分的供电分别有一块LM1117负责，这样可以最合理的进行功耗的分配，整个电路板不会有任何器件发热，从而增强电路的可靠性。
本开发板搭配的网络部分程序有两个。
其他程序均包含在内。
本文档用于大连酒游科技有限公司（第九单片机开发网 ）的MSP430以太网开发板。
如有不明，请联系QQ：15532299 也可在第九单片机开发网相关栏目下边进行提问。
开发板的默认IP为192.168.1.190；子网掩码：255.255.255.0；网关设置为：192.168.1.1.您可以根据您所在的局域网设置进行修改。
安卓软件服务器接口文档参考
用户文件列表
http://101.200.183.103:9999/a1/index?ct=list&aid=1&cid=0&o=user_ptime&asc=0&offset=0&limit=2 8
https://:1443/a1/index?ct=list&aid=1&cid=0&o=user_ptime&asc=0&offset=0&limit=2
8
ssl 加密连接
ct=list 为显示用户的文件列表 aid=1 为普通文件，默认为 1 cid=0 为父目录 id , 默认为 0 o=user_ptime 为排序方法
aes=0 0 为顺序排列，1 为倒序排列 offset=0 为从记录的第几条开始 limit=28 为每页显示数目 type= 为显示类型默认为空显示全部,视频 type=4 图片 type=2 文档 type=1 音乐 type=3 star= 是否只显示收藏文件 is_share 是否只显示共享 nf= 是否不显示文件
"t": "1382923656"，
"u": "http://192.168.1.235/thumb/4d/fb/4dfb7f9a94f339b4382ac93b28c7557a9b147b31_100_100?_t=1382 933175", //文件缩略图
"sha1": "4dfb7f9a94f339b4382ac93b28c7557a9b147b31" //文件 sha1 码
}],
"path": [{
接口文档
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个月以上，在国家机关进行依法查询时，予以提供。
构建标准OpenStackAPI接口文档
btw在devstack上这样配置完全没问题后来我尝试用kollaansible部署openstack也用这种方式重建网络却行不通不知道博主有没有啥建议呢
构建标准 OpenStackAPI接口文档
1.构建API接口文档标准参考： /contributor-guide/api-guides.html
2.构建API接口文档步骤参考下面的Patch： https:///#/c/361791/ https:///#/c/305870/ https:///#/c/305973/
3.创建API接口文档的CI已经如何发布到站。 (1)创建CI：https:///#/c/305464/ (2)发布成Html：https:///#/c/305485/
API接口文档(快速版)
API接口文档(快速版)概述本文档提供了关于API接口的快速参考指南，旨在帮助开发人员快速了解接口的功能和使用方法。
接口列表本文档涵盖以下API接口：... （根据实际情况继续列出其他接口）接口1：接口名称接口描述这个接口用于...请求请求类型- 请求方法：POST- 请求路径：/api/endpoint请求参数请求示例POST /api/endpoint {"param1": "value1", "param2": 123}响应响应参数响应示例{"param1": "value1", "param2": 123, ...}错误情况接口2：接口名称接口描述这个接口用于...请求请求类型- 请求方法：GET- 请求路径：/api/endpoint/{param} 请求参数请求示例GET /api/endpoint/abc123响应响应参数响应示例{"param1": "value1","param2": 123,...}错误情况接口3：接口名称接口描述这个接口用于...请求请求类型- 请求方法：PUT- 请求路径：/api/endpoint/{id} 请求参数请求示例PUT /api/endpoint/123 {"param1": "value1", ...}响应响应参数响应示例{"param1": "value1", "param2": 123,...}错误情况请根据实际情况修改接口的描述、请求参数、响应参数和错误情况等内容，并补充完整其他接口的信息。
以上仅为示例，不代表实际接口。
示范对外接口参数文档
⽰范对外接⼝参数⽂档⽰范接⼝参数⽂档模块⼀1、说明 ⽂档主要提供的是与系统对接时参数的相关说明。
以下⼏点需要注意： 1、系统间交互参数以JSON格式进⾏传输； 2、加签验签：系统会给接⼊者提供秘钥，发送请求需要根据秘钥进⾏加签，通过后才能进⾏交易请求；同样，对于返回的结果系统也会进⾏加签，接收⽅需要⽤秘钥进⾏原交易加签并进⾏⽐较验证数据的完整性。
注：加签验签⽅法调⽤提供的jar包调⽤相应的⽅法即可。
加签类为Sign。
交易请求时request.setHeaders(“code”);若在head标签中存放了当前机构code的MAP值，则⽀付系统的返回值sign标签会带有加签串。
若不传则返回的sign为null. 所有的接⼝含有异步应答的不论是否传输上诉字段返回的sign都需要进⾏验签。
3、验签串传输：应⽤发起请求前需要将调⽤加签⼯具类返回的加签串存放在key为sign的Map中，并在发送http请求时增加request.setHeaders(Map)⽅法。
4、返回格式报⽂：不同业务返回不⼀样，格式都是JSON，具体开发进⾏调试或者参考SDK开发包。
基本样例： {"sign":"88888888888888888888","result":{"errorCode":"900017","errorMsg":"未找到原交易信息","tokUrl":null, "data":{"traceNo":"418548"}}} 所有交易的返回格式都如上⾯的报⽂，主体分为两部分，sign为验签串，result为结果集。
其中result中的errorCode和errorMsg为参考应答码部分;backUrl为预留，暂不使⽤； data是根据不同交易返回不同的值； l 具体参考提供的开发SDK，⾥⾯提供了所有交易的模拟传输过程。
restFul接口设计规范[仅供参考]
![restFul接口设计规范[仅供参考]](https://img.taocdn.com/s3/m/a6ae2a1e53ea551810a6f524ccbff121dd36c591.png)
restFul接⼝设计规范[仅供参考]1. 域名应该尽量将API部署在专⽤域名之下。
https://如果确定API很简单，不会有进⼀步扩展，可以考虑放在主域名下。
https:///api/2. 版本（Versioning）应该将API的版本号放⼊URL。
/app/1.0/foo/app/1.1/foo/app/2.0/foo另⼀种做法是，将版本号放在HTTP头信息中，但不如放⼊URL⽅便和直观。
Github就采⽤了这种做法。
因为不同的版本，可以理解成同⼀种资源的不同表现形式，所以应该采⽤同⼀个URL。
版本号可以在HTTP请求头信息的Accept字段中进⾏区分（参见Versioning REST Services）：Accept: vnd.example-com.foo+json; version=1.0Accept: vnd.example-com.foo+json; version=1.1Accept: vnd.example-com.foo+json; version=2.03. 路径（Endpoint）路径⼜称"终点"（endpoint），表⽰API的具体⽹址，每个⽹址代表⼀种资源（resource）(1) 资源作为⽹址，只能有名词，不能有动词，⽽且所⽤的名词往往与数据库的表名对应。
举例来说，以下是不好的例⼦:/getProducts/listOrders/retreiveClientByOrder?orderId=1对于⼀个简洁结构，你应该始终⽤名词。
此外，利⽤的HTTP⽅法可以分离⽹址中的资源名称的操作。
GET /products ：将返回所有产品清单POST /products ：将产品新建到集合GET /products/4 ：将获取产品 4PATCH（或）PUT /products/4 ：将更新产品 4(2) API中的名词应该使⽤复数。
⽆论⼦资源或者所有资源。
API说明文档参考
Tuer API 说明文档Tuer API 依赖restify搭建，提供rest格式的API访问接口，API访问限制在1秒钟内最多访问3次。
o一种不需要授权访问的公共API，必须使用appkey才可以访问。
o一种必须使用用户授权token方式获取。
用户授权方式的API访问，必须在get参数中传递授权token，或者在http header中使用Authorization方式验证。
token的有效期默认为30天，过期后需要重新引导用户进行授权。
申请APPKEYAPPKEY申请步骤:o必须为兔耳网站注册用户,才允许申请。
申请地址o一个账户只能申请一个APPKEY，之后需要等待审核，审核成功后会邮件通知开发者。
o开发者可以通过账户设置->APPKEY管理，查看自己的APPKEY申请情况和进度.o申请完成并通过审核后，会发放一个APPKEY和一个sercet值，之后用于获取API权限和用户授权。
用户授权过程∙引导用户访问http://tuer.me/oauth/authorize?client_id=appkey&redirect_uri=callback_url进行登陆授权。
∙用户登陆兔耳帐号，之后带到相应app的授权页面。
∙允许授权后，网站会带着一个code值如http://myapp.foo/?code=xxxx跳到你的redirect_uri填写地址，此地址必须要和申请appkey时一致。
∙阻止授权后会跳转到http://myapp.foo/?error=access_denied地址，需要开发者自己处理。
当用户允许授权并回传给应用code值时，应用程序应该把code值，通过post的方式来兔耳的http://www.tuer.me/oauth/access_token换取token值。
o post需要传递的几个值为如下client_id:'appkey的值'client_secret:'appkey对应的secret值',redirect_url:'申请appkey时所写的回调地址',grant_type:'authorization_code', //固定写死code:code //回传给你的code值此时会在兔耳这个授权用户下创建应用和该用户关联的token，这个token会在post 的返回结果中附带，类似如下:{access_token:"xxxxx",tuer_uid:"user_id"} // tuer_uid为此用户id授权结束，这个时候就可以带着这个token值访问到该id的授权API，如果token过期则需要重新引导授权，默认为30天有效期。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
图片水印
uploadtype
图片上传类型
uploaduserid
上传图片的用户ID
filestream
图片上传流
issend
是否能发短信
messagetag
操作返回成功与否标识
functionid
评论功能ID
topicid
评论主题ID
keyword
搜索关键字
topicforwardnum
</requestinfo>
</request>
响应：
<?xml version=’1.0’encoding=’utf-8’?>
<response>
<message messageid=’<新生成展示评论ID>’/>
</response>
7.
请求：
<?xml version=’1.0’encoding=’utf-8’?>
<request actiontype=’postcommentadd’>
<requestinfo userid=’<当前登录用户id>’postid=’<展示ID>’touserid=’<展示作者ID>’>
<content><![CDATA[ '<评论内容>']]></content>
<upcontent><![CDATA[ '<展示标题>']]></upcontent>
原文转发数
topiccommentnum
原文评论数
total
分页总数
page
当前页
pagesize
每页显示条数
commentnum
评论数
forwardnum
转发数
collectionnum
收藏数
postnum
展示数
fansnum
粉丝数
blognum
微博数
atnum
@我的数
duanxinnum
短信数
guanzhunum
</request>
响应：
<?xml version=’1.0’encoding=’utf-8’?>
<response>
<common total=’<展示评论总数>’/>
<recordid=’<该条评论或回复的主键ID>’pinglunid=’<评论ID，若该记录为评论时为0>’touserid=’<评论或回复者ID>’nickname=’<评论或回复人昵称>’level=’<级别>’headimg=’<评论或回复者头像路径>’time=’<回复时间>’>
username
用户登录邮箱
password
密码
nickname
用户昵称
level
级别
renzheng
美空职业认证内容
job
职业
title
标题
desc
图片描述
url
图片路径
time
时间
from
来源
model
iphone手机型号
text
展示文本
actiontype
操作类型
postid
展示ID
messageid
关注数
picnum
展示图片数
特殊类
request
请求根节点
requestinfo
请求内容节点
response
响应根节点
recommend
推荐位图片节点
zfcomment
转发微博时并发送评论的节点
record
在列表或详情显示，每组内容都在此标签内
1.
请求：<?xml version=’1.0’encoding=’utf-8’?>
<requestactiontype=’indexpostlist’model=’<iphone型号>’>
<requestinfouserid=’<当前登录用户id,若是游客该结点没有>’type=’<类型1：MOKO 2：视觉3：艺术>’page=’<页码>’pagesize=’<每页显示条数>’/>
</request>
响应：
<?xml version=’1.0’encoding=’utf-8’?>
<response>
<message messageid =’<新生成收藏展示ID>’/>
</response>
9
请求：
<?xml version=’1.0’encoding=’utf-8’?>
<request actiontype=’postforward’>
…
</response>
5.
请求：
<?xml version=’1.0’encoding=’utf-8’?>
<request actiontype=’postcommentshow’model=’<iphone型号>’>
<requestinfouserid=’<当前登录用户id,若是游客该结点没有>’postid=’<展示ID>’page=’<页码>’pagesize=’<每页显示条数>’/>
插入数据库后产生的主键
blogid
微博ID
id
评论及回复的主键
pinglunid
评论ID
content
内容
upcontent
上文内容
topiccontent
原创微博内容
type
类型
topicnickname
原创微博用户昵称
topicuserid
原创微博用户ID
webservertag
图片上传服务器名
<requestinfo userid=’<当前登录用户id >’postid=’<展示ID>’/>
</request>
响应：
<?xml version=’1.0’encoding=’utf-8’?>
<response>
<message messageid=’<新生成微博ID>’/>
</response>
</request>
响应：
<?xml version=’1.0’encoding=’utf-8’?>
<response>
<common total=’<展示总数>’/>
<recommendpostid=’<展示ID>’img=’<展示图片地址>’/><!--类型为1时才有recommend节点-->
…
<recordpostid=’<展示ID>’nickname=’<用户昵称>’img=’<展示图片地址>’/>
…
</response>
3.
请求：
<?xml version=’1.0’encoding=’utf-8’?>
<request actiontype=’postdetailshow’model=’<iphone型号>’>
<request actiontype=’login’model=’<iphone型号>’>
<requestinfo username=’<用户邮箱>’password=’<密码>’/>
</request>
响应：
<?xml version=’1.0’encoding=’utf-8’?>
<response>
picupload
发布微博：将图片上传到图片服务器
blogadd
发布微博
blogforward
转发微博
userinfoshow
用户资料详细
duanxinadd
发短信
blogat
@TA
guanzhuadd
添加关注
guanzhudel
取消关注
guanzhulist
关注列表
fanslist
粉丝列表
postcollectionlist
展示收藏列表
messagese@我的列表
commentlist
评论列表
recommentadd
回复评论
duanxinlist
短信列表
duanxinshow
查看短信对话
usertoplist
人气排行榜
searchuser
用户搜索
searchpost
展示搜索
searchblog
<request actiontype=’postimgshow’model=’<iphone型号>’>
<requestinfopostid=’<展示ID>’/>