app服务器接口文档
阿里云内容安全API参考（检测服务）说明书
内容安全API参考（检测服务）··法律声明法律声明阿里云提醒您在阅读或使用本文档之前仔细阅读、充分理解本法律声明各条款的内容。
如果您阅读或使用本文档，您的阅读或使用行为将被视为对本声明全部内容的认可。
1. 您应当通过阿里云网站或阿里云提供的其他授权通道下载、获取本文档，且仅能用于自身的合法合规的业务活动。
本文档的内容视为阿里云的保密信息，您应当严格遵守保密义务；未经阿里云事先书面同意，您不得向任何第三方披露本手册内容或提供给任何第三方使用。
2. 未经阿里云事先书面许可，任何单位、公司或个人不得擅自摘抄、翻译、复制本文档内容的部分或全部，不得以任何方式或途径进行传播和宣传。
3. 由于产品版本升级、调整或其他原因，本文档内容有可能变更。
阿里云保留在没有任何通知或者提示下对本文档的内容进行修改的权利，并在阿里云授权通道中不时发布更新后的用户文档。
您应当实时关注用户文档的版本变更并通过阿里云授权渠道下载、获取最新版的用户文档。
4. 本文档仅作为用户使用阿里云产品及服务的参考性指引，阿里云以产品及服务的“现状”、“有缺陷”和“当前功能”的状态提供本文档。
阿里云在现有技术的基础上尽最大努力提供相应的介绍及操作指引，但阿里云在此明确声明对本文档内容的准确性、完整性、适用性、可靠性等不作任何明示或暗示的保证。
任何单位、公司或个人因为下载、使用或信赖本文档而发生任何差错或经济损失的，阿里云不承担任何法律责任。
在任何情况下，阿里云均不对任何间接性、后果性、惩戒性、偶然性、特殊性或刑罚性的损害，包括用户使用或信赖本文档而遭受的利润损失，承担责任（即使阿里云已被告知该等损失的可能性）。
5. 阿里云网站上所有内容，包括但不限于著作、产品、图片、档案、资讯、资料、网站架构、网站画面的安排、网页设计，均由阿里云和/或其关联公司依法拥有其知识产权，包括但不限于商标权、专利权、著作权、商业秘密等。
非经阿里云和/或其关联公司书面同意，任何人不得擅自使用、修改、复制、公开传播、改变、散布、发行或公开发表阿里云网站、产品程序或内容。
阿里云开放储存的APP开放文档
接口测试总结文档
接口测试的总结文档第一部分：主要从问题出发，引入接口测试的相关内容并与前端测试进行简单对比，总结两者之前的区别与联系。
但该部分只交代了怎么做和如何做？并没有解释为什么要做？第二部分：主要介绍为什么要做接口测试，并简单总结接口持续集成和接口质量评估相关内容。
第一部分：首先，在做接口测试的过程中，经常有后端开发会问：后端接口都测试什么？怎么测的？后端接口测试一遍，前端也测试一遍，是不是重复测试了？于是，为了向开发解释上述问题，普及基本的测试常识，特意梳理了接口测试的相关内容以及其与前端测试的区别，使开发团队与测试团队在测试这件上达成基本的共识，提高团队协作效率，从而更好的保证产品质量。
然后，我们试着回答上面的问题：问题1.1、后端接口都测试什么？--回答这个问题，我们可以从接口测试活动内容的角度下手，看一下面这张图，基本反应了当前我们项目后端接口测试的主要内容：问题1.2、我们怎么做接口测试？--由于我们项目前后端调用主要是基于http协议的接口，所以测试接口时主要是通过工具或代码模拟http请求的发送与接收。
工具有很多如：postman、jmeter、soupUI、java+httpclient、robotframework+httplibrary等。
问题2、后端接口测试一遍，前端也测试一遍，是不是重复测试了？--回答这个问题，我们可以直接对比接口测试和app端测试活动的内容，如下图为app测试时需要覆盖或考虑内容：从上面这两张图对比可以看出，两个测试活动中相同的部分有功能测试、边界分析测试和性能测试，其它部分由于各自特性或关注点不同需要进行特殊的测试，在此不做讨论。
接下来我们针对以上三部分相同的内容再进行分析：1、基本功能测试：由于是针对基本业务功能进行测试，所以这部分是两种测试重合度最高的一块，开发同学通常所指的也主要是这部分的内容。
2、边界分析测试：在基本功能测试的基础上考虑输入输出的边界条件，这部分内容也会有重复的部分（比如业务规则的边界）。
app接口测试手册1.0.2
书旗APP接口测试手册修订记录日期版本号类别描述作者2014-6-9 1.0.0 A 增加接口测试工具使用说明；示例说明接口测试思路及测试用例分析梁丽君2014-6-17 1.0.2 M 修改和增加测试原理和测试逻辑说明梁丽君目录1接口测试工具使用说明 (3)1.1 【接口设置】--【接口分组】 (3)1.2 【接口设置】--【新建接口】 (3)1.3 【接口设置】--【查看接口】 (4)1.4 【测试】--【接口测试】 (5)2 测试用例位置说明 (6)3 接口测试说明 (7)3.1 【用户相关接口】模块说明 (7)3.1.1 【用户身份唯一性验证及生成接口】用例设计 (8)3.2【书旗书城IOS接口】模块说明 (24)3.2.2 【获取书签接口】用例设计 (25)3.3 【书旗书城接口】模块说明 (30)3.3.1 【购买章节接口】用例设计 (32)3.4 【一搜接口】模块说明 (43)3.4.1 【书本检查更新接口】用例设计 (44)3.5【支付类接口】模块说明 (50)3.5.1【UC支付充值接口】用例设计 (51)1接口测试工具使用说明工具地址：http://210.14.131.100:8887/auth/login工具维护接口人：殷振华登陆帐号：默认你的姓名全拼密码：123456主要功能使用介绍：1.1 【接口设置】--【接口分组】用途：标识被测接口特性分类1.2 【接口设置】--【新建接口】接口名称：对应用例名称分组：所属接口组名URL：被测接口地址URL参数：此处传递的参数对应接口文档中的get参数部分。
格式形如：bookid(94525),user_id(23423423) ，多个参数之间用英文逗号分隔；同一个参数存在多个值时，使用下划线_ 分隔，形如：bookid(94532425_945324_3234425_55524234) 方法：仅包含URL参数时，默认选中GET方法；当包含POST数据时，选择POST方法POST数据：对应接口文档中需要传递的post参数，文档中没有标注清楚时，需要找相关研发人员进行确认。
接口测试知识点
接口测试知识点一、知识概述《接口测试知识点》①基本定义：接口测试嘛，简单说就是测试系统之间交互的接口，就像查两个小伙伴之间的传话筒能不能好好工作那样。
接口就是不同软件组件或者系统之间沟通的桥梁，我们要看看这个桥梁在数据传递、功能调用等方面有没有问题。
②重要程度：在软件测试里它可很重要哦。
就像一个大厦，接口就是连接各个房间（不同模块）的通道，通道要是出问题，那大厦可就乱套了。
它能比只测单个功能更早地发现问题，在系统集成之前就把潜藏的风险挖出来。
③前置知识：先得对软件开发的基础流程有了解，像什么需求分析、设计、开发的基本概念。
而且对于HTTP这些常见协议也要有点儿概念，因为很多接口都是基于HTTP协议工作的。
④应用价值：实际中很多软件都不是一个整体动起来的，都是不同部分组合起来的。
比如电商系统，库存系统、订单系统、支付系统之间要有接口互通。
接口测试好了，能保证这些系统对接顺畅，避免数据错误、功能缺失、性能低下等问题。
二、知识体系①知识图谱：在软件测试学科里，接口测试和单元测试、集成测试都有关系。
单元测试像是检查细胞（独立的功能模块）健康不健康，接口测试就在单元测试和集成测试之间，确保细胞之间传递信息的时候没有错。
然后集成测试就像把各个健康的器官（集成好的多个模块）组合起来看整个身体（完整系统）能不能工作。
②关联知识：和协议知识关联很大，像HTTP或者RPC协议等。
还和数据库知识有关联，因为接口有时候需要操作数据库。
也跟自动化测试知识有关，很多接口测试现在都自动化了。
③重难点分析：- 掌握难度：有点难哦。
要理解接口文档就不容易，那里面有各种字段的定义、接口的调用规则。
而且还得处理各种数据格式，像JSON 和XML。
- 关键点：关键就是要把接口文档读明白喽。
还有处理好接口之间的依赖关系。
④考点分析：- 在考试中的重要性：如果是软件测试相关的考试，这是挺重要的一部分。
能考查你对系统交互理解和测试的能力。
- 考查方式：可能会让你根据一个接口文档写测试用例，或者给出一个接口出错的情况让你分析原因。
开心网开放API说明文档
开心网开放API 说明文档V1.02011-01-14开心网开放API说明文档开放API是开心网为第三方开发者提供的一组功能强大的外部接口，它支持Java、PHP、.NET等多种编程语言。
借助开放API，第三方开发者可以在开心网平台上方便的开发组件或实现连接功能。
一、已开放的API列表开心网开放平台API是采用REST基础的接口规范。
所有的开心网开放平台API都是通过HTTP POST向/api/rest.php发送请求来实现的。
用户信息调用接口（users API）●身份信息调用接口（users.getInfo）：获取已安装本组件的某一用户的身份信息，包括UID、姓名、性别、头像以及该用户是否在线；●UID调用接口（users.getLoggedInUser）：获取当前用户（正在使用该组件的用户）的UID；●组件用户判断接口（users.isAppUser）：判断某一用户是否安装了本组件；●获取调用开心币接口verify（users.getEncodeSessionKey）：获取调用开心币接口需要的verify参数；●邀请成功的好友UID接口（users.getInvitationSucList）：获取某用户邀请成功的好友UID列表。
好友信息调用接口（friends API）●好友列表调用接口（friends.get）：获取当前登录用户的好友UID列表；●好友身份信息调用接口（friends.getFriends）：获取当前登录用户的好友身份信息，包括UID、姓名、性别、头像以及该用户是否在线；●添加了当前组件的好友调用接口（friends.getAppFriends）：获取添加了当前组件好友的UID列表。
功能调用接口（actions API）●好友动态调用接口（actions.sendNewsFeed）：发送好友动态接口，即把组件内的动态发送给全部开心网好友；●系统消息调用接口（actions.sendSysNews）：发送系统消息接口，即把组件内的信息通过系统消息发送给部分开心网好友；●好友邀请调用接口（actions.sendInvitation）：发送组件邀请接口，即以系统消息的形式从组件内发出邀请，邀请好友添加该组件。
友盟使用文档
友盟使⽤⽂档友盟消息推送服务器端API V1.0指南1 概述1.1 基本说明本⽂所描述的API接⼝均基于HTTP Rest协议, 若⽆特殊说明接⼝均使⽤UTF-8编码, 消息体参数以及返回结果均采⽤Json格式。
注意: 使⽤API前需要在Web后台获取appkey 和app_master_secret，同时在web 后台添加服务器IP地址做IP⽩名单过滤。
1.2 基本概念appkey：应⽤唯⼀标识app_master_secret：服务器Key。
device_token: 友盟后台对设备的唯⼀标识。
注意, Android的device_token是44位字符串, iOS的device-token是64位。
单播: 向指定的设备发送消息。
⼴播: 向安装该APP的所有设备发送消息。
组播: 向满⾜特定条件的设备集合发送消息，例如: "特定版本"、"特定地域"等。
alias: 第三⽅账号, 开发者可以在SDK中调⽤setAlias接⼝，SDK会把设定的alias,alias_type与device_token进⾏绑定传回到后端。
便于开发者通过⾃有业务逻辑筛选出alias，通过发送alias给友盟进⾏消息推送。
通知-Android: 消息送达到⽤户设备后，由友盟处理内容并在通知栏上显⽰通知内容。
消息-Android: 消息送达到⽤户设备后，消息内容被传递给应⽤⾃⼰解析和后续处理，友盟不对消息内容进⾏展⽰和提醒。
通知/消息-iOS: 和APNs定义⼀致。
测试模式-Android: 在⼴播、组播等⼤规模发送消息的情况下，为了防⽌开发者误发消息, 增加了测试模式。
测试模式下，只会将消息发送给测试设备。
测试设备需要到⽹站上添加。
测试模式对单播不⽣效。
测试模式-iOS: iOS的测试模式对应APNs的开发环境(sandbox)。
2 接⼝描述2.1 消息发送2.1.1 功能说明开发者调⽤此接⼝，向指定终端⽤户(单播)、所有终端⽤户(⼴播) 或满⾜特定条件的终端⽤户群(组播)，发送通知或消息。
平台对接文档
Version 1.0
五洲在线电子商务公司
1 / 35
目录
1 设计背景...........................................................................................3 2 设计概述...........................................................................................3
2 / 35
14.1 数据结构...................................................................................................... - 8 15 每日订单收发汇总.................................................................... - 10 -
15.1 数据结构.................................................................................................... - 10 16 订单取消接口............................................................................ - 11 -
2.1 API 接入环境 ................................................................................................
api接口写法
api接口写法API接口的写法通常包括以下几个步骤：定义接口：确定接口的功能和输入输出参数，编写接口文档，并确定接口的版本号。
设计接口：根据需求设计接口的数据结构、请求方法（GET、POST、PUT、DELETE 等）、请求的URL和参数、返回的数据格式等。
实现接口：编写代码实现接口的具体逻辑，包括处理请求、调用相关业务逻辑或数据库操作等。
测试接口：对接口进行测试，确保接口的功能正常、性能良好、安全可靠。
发布接口：将接口部署到服务器上，供客户端调用。
具体来说，一个简单的API接口的写法可能如下：pythonfrom flask import Flask, request, jsonifyapp = Flask(__name__)@app.route('/api/v1/users', methods=['GET'])def get_users():users = [{"id": 1, "name": "Alice"}, {"id": 2, "name": "Bob"}] return jsonify(users)@app.route('/api/v1/users/<int:user_id>', methods=['GET']) def get_user(user_id):user = {"id": user_id, "name": "User"}return jsonify(user)@app.route('/api/v1/users/<int:user_id>', methods=['PUT']) def update_user(user_id):data = request.get_json()user = {"id": user_id, "name": data["name"]}return jsonify(user)if __name__ == '__main__':app.run(debug=True)以上代码使用了Flask框架实现了一个简单的API接口，包括获取所有用户、获取指定用户、更新指定用户的功能。
【微信APP支付】接口文档V1.2_For_IOS
3
[package appendString:"&"]; } [package appendString:"key="]; [package appendString:PARTNERKEY]; // 注意：不能hardcode在客户端，建议genPackage这 个过程都由服务器端完成 // 进行md5摘要前，params内容为原始内容，未经过url encode处理 String packageSign = package.md5.uppercaseString; return [NSString stringWithFormat:@"%@&sign=%@",paragramString,packageSigSMutableString *signText = [NSMutableString string]; for (NSString *key in [params allKeys]) { [signText appendString:key]; [signText appendString:@"="]; [signText appendString:[params objectForKey:key]]; [signText appendString:"&"]; } NSString *signResult = signText.sha1; // 注意：不能hardcode在客户端，这个过程都由服务器端完 成
参数 appid
traceid noncestr package timestamp app_signature
是否必须 是 否 是 是 是 是
说明 应用唯一标识，在微信开放平台提交应用审核通 过后获得
uni.connectsocket案例
1. 背景介绍uni.connectSocket是一个用于连接服务器的API接口，是由uni-app框架提供的网络通信能力之一。
在移动应用开发中，uni.connectSocket可以帮助开发者实现客户端与服务器端的实时通讯，包括数据传输和接收等功能。
该接口的使用可以极大地提升移动应用的用户体验和功能丰富程度。
2. uni.connectSocket的作用uni.connectSocket的主要作用是建立客户端与服务器端的TCP连接，实现实时数据传输。
通过该接口，客户端可以向服务器发送请求并接收服务器返回的数据，实现网络通讯功能。
3. uni.connectSocket的基本用法uni.connectSocket的基本用法包括以下几个步骤：(1) 创建Socket实例：在客户端代码中调用uni.connectSocket创建一个Socket实例，并指定服务器位置区域和端口号。
(2) 监听Socket连接状态：通过uni.onSocketOpen、uni.onSocketError和uni.onSocketClose等API接口，监听Socket 连接的打开、错误和关闭事件。
(3) 发送数据：通过uni.sendSocketMessage向服务器发送数据。
(4) 接收数据：通过uni.onSocketMessage监听服务器返回的数据。
(5) 关闭连接：通过uni.closeSocket关闭Socket连接。
4. uni.connectSocket的参数说明(1) url：String类型，必填，表示要连接的服务器位置区域。
(2) data：String/ArrayBuffer类型，可选，表示要发送的数据。
(3) header：Object类型，可选，表示要发送的数据的请求头。
(4) method：String类型，可选，表示发送请求的方法，有效值有"GET"、"POST"。
api接口流程
api接口流程
API接口流程一般包括以下几个步骤：
１．请求: 客户端（如网页、APP或其他服务）向服务器发送请求。
请求中包含需要的数据，如URL、HTTP方法（GET、POST 等）、请求头和请求体等。
２．接收请求: 服务器接收请求并开始处理。
这一步中，服务器可能会对请求进行验证，比如检查是否有正确的认证信息。
３．处理请求: 服务器根据接收到的请求进行相应的处理。
这可能包括查询数据库、执行某些操作或进行计算等。
４．返回结果: 处理完成后，服务器将结果返回给客户端。
返回的数据通常包含在HTTP响应中，如状态码、响应头和响应体等。
５．客户端响应: 客户端接收到响应后，会根据具体情况进行下一步操作，比如显示数据、进行跳转或发送新的请求等。
以上是一个基本的API接口流程。
在实际应用中，根据具体需求和设计，流程可能会有所不同，例如可能包括异常处理、日志记录、缓存机制等。
微信支付 APP支付(Android)接口文档V1.7
APP支付接口文档V1.7版本说明版本更改说明更新时间V1.5公众号1.5版本升级2014-04-15 V1.6更新实例代码成实际可运行2014-04-29 V1.7更新订单号重复说明2014-06-181.微信支付简介1.1功能简介 (4)1.2平台帐号注册 (5)1.2.1申请流程指引图 (5)1.2.2申请接入步骤详细说明 (5)1.3支付账户 (6)2.微信APP支付接入 (8)2.1系统架构 (8)2.2基本交互 (8)2.3支付功能开发介绍 (9)3.接口介绍 (10)3.1获取access_token (10)3.2生成预支付订单 (11)3.3订单详情（package）扩展字符串定义 (12)3.4支付签名（app_signature）生成方法 (14)3.5添加prepayid再次签名 (15)3.6APP端开发说明 (16)3.6.1初始化设置 (16)3.6.2注册您的APPID (16)3.6.3用服务器返回的参数调起支付 (17)4.通知接口说明 (18)4.1通知接口简介 (18)4.2补单机制 (18)4.3通知接口参数 (18)4.4后台通知结果返回 (21)4.5后台通知签名方式 (21)5.API接口说明 (23)5.1API接口简介 (23)5.2API列表 (23)5.2.1发货通知delivernotify (23)5.2.2订单查询orderquery (25)6.常见问题和注意事项 (27)6.1帮助SDK (27)6.2常见基本概念疑惑 (28)6.3常见错误现象及解决方法 (28)6.4常见注意事项 (29)6.5最新接口文档下载 (29)6.6联系我们 (30)1.微信支付简介1.1功能简介微信APP支付，是基于微信客户端提供的支付服务功能。
在第三方APP集成微信支付模块后即可完成商户购买支付流程。
本文将全面介绍微信APP支付的技术方案。
1.2平台帐号注册1.2.1申请流程指引图1.2.2申请接入步骤详细说明a.目前仅对通过微信开放平台移动应用审核的APP开放微信支付申请入口，请登录微信开放平台，添加移动应用，等待审核。
App开放接口api安全性—Token签名sign的设计与实现
App开放接⼝api安全性—Token签名sign的设计与实现前⾔在app开放接⼝api的设计中，避免不了的就是安全性问题，因为⼤多数接⼝涉及到⽤户的个⼈信息以及⼀些敏感的数据，所以对这些接⼝需要进⾏⾝份的认证，那么这就需要⽤户提供⼀些信息，⽐如⽤户名密码等，但是为了安全起见让⽤户暴露的明⽂密码次数越少越好，我们⼀般在web项⽬中，⼤多数采⽤保存的session中，然后在存⼀份到cookie中，来保持⽤户的回话有效性。
但是在app提供的开放接⼝中，后端服务器在⽤户登录后如何去验证和维护⽤户的登陆有效性呢，以下是参考项⽬中设计的解决⽅案，其原理和⼤多数开放接⼝安全验证⼀样，如淘宝的开放接⼝token验证，微信开发平台token验证都是同理。
签名设计对于敏感的api接⼝，需使⽤https协议https是在http超⽂本传输协议加⼊SSL层，它在⽹络间通信是加密的，所以需要加密证书。
https协议需要ca证书，⼀般需要交费。
签名的设计原理：⽤户登录后向服务器提供⽤户认证信息（如账户和密码），服务器认证完后给客户端返回⼀个Token令牌，⽤户再次获取信息时，带上此令牌，如果令牌正取，则返回数据。
对于获取Token信息后，访问⽤户相关接⼝，客户端请求的url需要带上如下参数：时间戳：timestampToken令牌：token然后将所有⽤户请求的参数按照字母排序（包括timestamp，token），然后更具MD5加密（可以加点盐），全部⼤写，⽣成sign签名，这就是所说的url签名算法。
然后登陆后每次调⽤⽤户信息时，带上sign，timestamp，token参数。
加上时间戳和token然后更具url参数⽣成sign最终的请求如其最终的原理是减⼩明⽂的暴露次数；保证数据安全的访问。
具体实现如下：1. api请求客户端想服务器端⼀次发送⽤⽤户认证信息（⽤户名和密码），服务器端请求到改请求后，验证⽤户信息是否正确。
中文AppiumAPI文档
中⽂AppiumAPI⽂档中⽂Appium API ⽂档第⼀章：关于appium1.1 appium客户端客户端类库列表及Appium服务端⽀持这些类库封装了标准Selenium客户端类库，为⽤户提供所有常见的JSON 格式selenium命令以及额外的移动设备控制相关的命令，如多点触控⼿势和屏幕朝向。
Appium客户端类库实现了Mobile JSON Wire Protocol（⼀个标准协议的官⽅扩展草稿）和W3C Webdriver spec（⼀个传输不可预知的⾃动化协议，该协议定义了MultiAction 接⼝）的元素。
1.2 appium介绍Appium 介绍Appium 是⼀个⾃动化测试开源⼯具，⽀持 iOS 平台和 Android 平台上的原⽣应⽤，web 应⽤和混合应⽤。
所谓的“移动原⽣应⽤”是指那些⽤ iOS 或者 Android SDK 写的应⽤。
所谓的“移动 web 应⽤”是指使⽤移动浏览器访问的应⽤（Appium ⽀持iOS 上的 Safari 和 Android 上的 Chrome）。
所谓的“混合应⽤”是指原⽣代码封装⽹页视图——原⽣代码和 web 内容交互。
⽐如，像Phonegap，可以帮助开发者使⽤⽹页技术开发应⽤，然后⽤原⽣代码封装，这些就是混合应⽤。
重要的是，Appium 是⼀个跨平台的⼯具：它允许测试⼈员在不同的平台（iOS，Android）使⽤同⼀套API来写⾃动化测试脚本，这样⼤⼤增加了 iOS 和 Android 测试套件间代码的复⽤性。
想知道 Appium 如何⽀持平台，版本和⾃动化形态的详细信息，请参见platform support doc。
Appium 的理念为了满⾜移动⾃动化需求，Appium 遵循着⼀种哲学，重点体现于以下4个需求：你⽆需为了⾃动化，⽽重新编译或者修改你的应⽤。
你不必局限于某种语⾔或者框架来写和运⾏测试脚本。
⼀个移动⾃动化的框架不应该在接⼝上重复造轮⼦。
华为云计算技术有限公司 ROMA Connect API 参考文档说明书
应用与数据集成平台(ROMA Connect) 1.10.0API参考文档版本01发布日期2023-03-30版权所有 © 华为云计算技术有限公司 2023。
保留一切权利。
非经本公司书面许可，任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部，并不得以任何形式传播。
商标声明和其他华为商标均为华为技术有限公司的商标。
本文档提及的其他所有商标或注册商标，由各自的所有人拥有。
注意您购买的产品、服务或特性等应受华为云计算技术有限公司商业合同和条款的约束，本文档中描述的全部或部分产品、服务或特性可能不在您的购买或使用范围之内。
除非合同另有约定，华为云计算技术有限公司对本文档内容不做任何明示或暗示的声明或保证。
由于产品版本升级或其他原因，本文档内容会不定期进行更新。
除非另有约定，本文档仅作为使用指导，本文档中的所有陈述、信息和建议不构成任何明示或暗示的担保。
华为云计算技术有限公司地址：贵州省贵安新区黔中大道交兴功路华为云数据中心邮编：550029网址：https:///目录1 使用前必读 (1)1.1 概述 (1)1.2 调用说明 (1)1.3 终端节点 (1)1.4 约束与限制 (3)1.5 基本概念 (3)2 如何调用API (4)2.1 构造请求 (4)2.2 认证鉴权 (7)2.3 返回结果 (11)3 公共资源API (13)3.1 应用管理 (13)3.1.1 校验应用是否存在 (13)3.1.2 查询应用列表 (16)3.1.3 创建应用 (20)3.1.4 查询应用详情 (24)3.1.5 更新应用 (27)3.1.6 删除应用 (31)3.1.7 查询应用密钥 (32)3.1.8 重置应用密钥 (34)3.1.9 查询用户成员列表 (37)3.1.10 设置用户成员 (40)3.1.11 查询候选用户成员 (43)3.2 资产管理 (46)3.2.1 下载资产包 (46)3.2.2 批量导出资产 (47)3.2.3 导入资产 (50)3.2.4 查询作业进度 (52)3.2.5 批量删除资产 (55)3.3 字典管理 (57)3.3.1 校验字典是否存在 (58)3.3.2 查询字典列表 (60)3.3.4 查询字典详情 (66)3.3.5 更新字典 (69)3.3.6 删除字典 (72)3.4 公共管理 (73)3.4.1 获取服务API版本列表 (74)3.4.2 获取指定版本ID的API版本信息 (75)3.5 实例管理 (77)3.5.1 查询实例列表 (77)4 数据集成API (84)4.1 数据源管理 (84)4.1.1 创建数据源 (84)4.1.2 查询数据源 (117)4.1.3 查询指定数据源 (137)4.1.4 修改数据源 (154)4.1.5 删除指定数据源信息 (187)4.1.6 获取数据源中所有的表 (189)4.1.7 获取数据源中某个表中所有字段 (193)4.1.8 测试数据源连通性 (197)4.2 任务监控管理 (216)4.2.1 查询任务监控信息列表 (216)4.2.2 查询单个任务的日志详情 (222)4.3 任务管理 (233)4.3.1 创建普通任务 (233)4.3.2 查询任务列表 (239)4.3.3 统计不同类型不同状态任务数量 (246)4.3.4 更新普通任务 (249)4.3.5 查询指定任务的信息 (256)4.3.6 删除指定任务 (260)4.3.7 手工触发单个任务 (263)4.3.8 手工停止当前执行的任务 (265)4.3.9 创建调度计划 (268)4.3.10 查询调度计划 (273)4.3.11 修改调度计划 (277)4.3.12 批量启动或停止任务 (282)4.3.13 创建组合任务 (286)4.3.14 组合任务初始化 (290)4.3.15 修改组合任务 (298)4.3.16 重置组合任务进度 (301)4.3.17 创建组合任务映射 (304)4.3.18 删除指定任务映射 (309)5 服务集成API (313)5.1.1 查看实例详情 (313)5.1.2 查看实例约束信息 (322)5.2 API分组管理 (325)5.2.1 创建API分组 (325)5.2.2 修改API分组 (331)5.2.3 删除API分组 (337)5.2.4 查询分组详情 (340)5.2.5 查询分组列表 (345)5.2.6 校验API分组名称是否存在 (352)5.3 API管理 (355)5.3.1 创建API (356)5.3.2 修改API (402)5.3.3 删除API (444)5.3.4 发布或下线API (447)5.3.5 查询API详情 (451)5.3.6 查询API列表 (473)5.3.7 批量发布或下线API (486)5.3.8 调试API (491)5.3.9 切换API版本 (497)5.3.10 查看版本详情 (501)5.3.11 根据版本编号下线API (523)5.3.12 查询API历史版本列表 (526)5.3.13 查询API运行时定义 (530)5.3.14 校验API定义 (538)5.4 环境管理 (542)5.4.1 创建环境 (542)5.4.2 修改环境 (546)5.4.3 删除环境 (550)5.4.4 查询环境列表 (553)5.5 环境变量管理 (557)5.5.1 新建变量 (557)5.5.2 删除变量 (562)5.5.3 查看变量详情 (564)5.5.4 查询变量列表 (568)5.5.5 修改变量 (572)5.6 域名管理 (576)5.6.1 绑定域名 (576)5.6.2 绑定域名证书 (581)5.6.3 修改域名 (586)5.6.4 解绑域名 (591)5.6.5 删除域名证书 (594)5.7 流控策略管理 (601)5.7.1 创建流控策略 (601)5.7.2 修改流控策略 (607)5.7.3 删除流控策略 (614)5.7.4 查询流控策略列表 (616)5.7.5 查看流控策略详情 (621)5.8 API绑定流控策略 (625)5.8.1 绑定流控策略 (626)5.8.2 解除API与流控策略的绑定关系 (629)5.8.3 查看流控策略绑定的API列表 (632)5.8.4 查看流控策略未绑定的API列表 (637)5.8.5 查看API绑定的流控策略列表 (642)5.8.6 批量解绑流控策略 (648)5.9 设置特殊流控 (652)5.9.1 创建特殊设置 (652)5.9.2 修改特殊设置 (656)5.9.3 删除特殊设置 (660)5.9.4 查看特殊设置列表 (663)5.10 签名密钥管理 (668)5.10.1 创建签名密钥 (668)5.10.2 修改签名密钥 (676)5.10.3 删除签名密钥 (683)5.10.4 查询签名密钥列表 (685)5.11 签名密钥绑定关系管理 (691)5.11.1 绑定签名密钥 (691)5.11.2 解除绑定 (698)5.11.3 查看API绑定的签名密钥列表 (701)5.11.4 查看签名密钥未绑定的API列表 (707)5.11.5 查看签名密钥绑定的API列表 (711)5.12 ACL策略管理 (716)5.12.1 创建ACL策略 (716)5.12.2 修改ACL策略 (720)5.12.3 删除ACL策略 (725)5.12.4 批量删除ACL策略 (728)5.12.5 查看ACL策略详情 (732)5.12.6 查看ACL策略列表 (735)5.13 API绑定ACL策略 (740)5.13.1 将API与ACL策略进行绑定 (740)5.13.2 解除API与ACL策略的绑定 (744)5.13.3 批量解除API与ACL策略的绑定 (747)5.13.4 查看ACL策略绑定的API列表 (752)5.13.6 查看API绑定的ACL策略列表 (761)5.14 OpenAPI接口 (765)5.14.1 导出API (765)5.14.2 导入API (769)5.14.3 导出自定义后端API (775)5.14.4 导入自定义后端API (778)5.15 VPC通道管理 (783)5.15.1 创建VPC通道 (783)5.15.2 更新VPC通道 (797)5.15.3 删除VPC通道 (810)5.15.4 查看VPC通道详情 (813)5.15.5 查询VPC通道列表 (824)5.15.6 添加或更新后端实例 (832)5.15.7 查看后端实例列表 (839)5.15.8 更新后端实例 (845)5.15.9 删除后端实例 (851)5.15.10 批量修改后端服务器状态可用 (855)5.15.11 批量修改后端服务器状态不可用 (857)5.15.12 修改VPC通道健康检查 (860)5.15.13 添加或更新VPC通道后端服务器组 (866)5.15.14 查询VPC通道后端云服务组列表 (872)5.15.15 查看VPC通道后端服务器组详情 (877)5.15.16 删除VPC通道后端服务器组 (881)5.15.17 更新VPC通道后端服务器组 (884)5.16 客户端配置 (889)5.16.1 查询APP列表 (889)5.16.2 查看APP详情 (894)5.16.3 创建APP Code (898)5.16.4 自动生成APP Code (902)5.16.5 查询APP Code列表 (906)5.16.6 查看APP Code详情 (910)5.16.7 删除APP Code (914)5.16.8 查询客户端应用关联的应用配额 (917)5.16.9 设置APP的访问控制 (921)5.16.10 查看APP的访问控制详情 (924)5.16.11 删除APP的访问控制 (928)5.17 客户端配额 (931)5.17.1 创建客户端配额 (931)5.17.2 修改客户端配额 (936)5.17.3 删除客户端配额 (940)5.17.4 获取客户端配额详情 (943)5.17.6 客户端配额绑定客户端应用列表 (951)5.17.7 解除客户端配额和客户端应用的绑定 (955)5.17.8 查询客户端配额已绑定的客户端应用列表 (958)5.17.9 查询客户端配额可绑定的客户端应用列表 (962)5.18 APP授权管理 (967)5.18.1 APP授权 (967)5.18.2 解除授权 (972)5.18.3 查看APP已绑定的API列表 (975)5.18.4 查看APP未绑定的API列表 (981)5.18.5 查看APP下路径冲突的api列表 (985)5.18.6 查看API已绑定的APP列表 (990)5.19 自定义后端服务 (995)5.19.1 创建后端API (995)5.19.2 修改后端API (1005)5.19.3 删除后端API (1015)5.19.4 查询后端API详情 (1018)5.19.5 查询后端API列表 (1025)5.19.6 创建后端API脚本 (1033)5.19.7 测试后端API (1042)5.19.8 查询后端API测试结果 (1047)5.19.9 部署后端API (1051)5.19.10 查询后端API部署历史 (1061)5.19.11 撤销后端API (1068)5.19.12 校验自定义后端API定义 (1071)5.19.13 查询自定义后端服务配额 (1075)5.19.14 查询自定义后端服务数据源列表 (1078)5.19.15 批量下线自定义后端API (1083)5.20 自定义认证管理 (1087)5.20.1 创建自定义认证 (1087)5.20.2 修改自定义认证 (1093)5.20.3 删除自定义认证 (1098)5.20.4 查看自定义认证详情 (1101)5.20.5 查询自定义认证列表 (1106)5.21 监控信息查询 (1111)5.21.1 API指标统计值查询-最近一段时间 (1111)5.21.2 查询API指标统计值 (1116)5.21.3 按照集成应用维度查询调用应用指标统计值 (1123)5.21.4 不同调用应用请求的指标统计值TopN (1129)5.21.5 查询应用请求的指标统计值 (1134)5.21.6 查询所有集成应用的指标统计值TopN (1140)5.22 实例特性管理 (1147)5.22.2 实例配置特性 (1152)5.23 标签管理 (1155)5.23.1 查询标签列表 (1156)5.24 配置管理 (1159)5.24.1 查询某个实例的租户配置列表 (1159)5.25 应用配置管理 (1167)5.25.1 创建应用配置 (1167)5.25.2 修改应用配置 (1171)5.25.3 删除应用配置 (1175)5.25.4 查看应用配置详情 (1178)5.25.5 查询应用配置列表 (1182)5.26 VPC通道管理-项目级 (1186)5.26.1 查询项目下所有实例的VPC通道列表 (1186)5.27 API任务管理 (1196)5.27.1 创建API定时任务 (1196)5.27.2 修改API定时任务 (1205)5.27.3 删除API定时任务 (1214)5.27.4 查询API任务列表 (1217)5.27.5 查询API定时任务详情 (1225)5.27.6 启动API定时任务 (1232)5.27.7 停止API定时任务 (1238)5.27.8 批量启动API定时任务 (1245)5.27.9 批量停止API定时任务 (1249)5.27.10 批量删除API定时任务 (1253)5.28 微服务中心管理 (1258)5.28.1 导入微服务 (1258)5.29 SSL证书管理 (1266)5.29.1 获取SSL证书列表 (1266)5.29.2 创建SSL证书 (1271)5.29.3 域名绑定SSL证书 (1277)5.29.4 域名解绑SSL证书 (1280)5.29.5 查看证书详情 (1284)5.29.6 删除SSL证书 (1288)5.29.7 修改SSL证书 (1291)5.29.8 SSL证书绑定域名 (1297)5.29.9 SSL证书解绑域名 (1301)5.29.10 获取SSL证书已绑定域名列表 (1305)5.30 插件管理 (1309)5.30.1 创建插件 (1309)5.30.2 修改插件 (1316)5.30.3 删除插件 (1324)5.30.5 查询插件详情 (1332)5.30.6 插件绑定API (1337)5.30.7 API绑定插件 (1341)5.30.8 解除绑定插件的API (1346)5.30.9 解除绑定API的插件 (1349)5.30.10 查询插件下绑定的API (1352)5.30.11 查询API下绑定的插件 (1358)5.30.12 查询可绑定当前插件的API (1363)5.30.13 查询可绑定当前API的插件 (1369)6 消息集成API（Kafka引擎） (1375)6.1 MQS实例管理 (1375)6.1.1 查询MQS实例列表 (1375)6.1.2 查询MQS实例详情 (1382)6.2 主题管理 (1390)6.2.1 查询Topic列表 (1390)6.2.2 创建Topic (1394)6.2.3 修改Topic (1397)6.2.4 删除Topic (1399)6.2.5 批量删除Topic (1402)6.2.6 导入Topic (1404)6.2.7 导出Topic (1406)6.3 应用权限管理 (1408)6.3.1 更新Topic权限 (1408)6.3.2 查询Topic权限 (1411)6.4 消息管理 (1414)6.4.1 查询消息 (1414)6.4.2 重发消息 (1418)6.4.3 查询消息轨迹 (1421)7 设备集成API (1426)7.1 设备分组管理 (1426)7.1.1 创建设备分组 (1426)7.1.2 查询所有设备分组 (1431)7.1.3 删除设备分组 (1436)7.1.4 查询设备分组详情 (1439)7.1.5 修改设备分组 (1444)7.1.6 批量添加设备到设备分组 (1450)7.1.7 删除设备分组内的设备 (1453)7.2 设备管理 (1457)7.2.1 创建设备 (1457)7.2.2 查询设备 (1467)7.2.3 设备批量下线 (1479)7.2.5 查询设备详情 (1486)7.2.6 修改设备 (1495)7.2.7 查询设备主题 (1504)7.2.8 添加子设备到网关 (1509)7.2.9 查询子设备 (1516)7.2.10 查询设备影子 (1525)7.2.11 重置设备鉴权信息 (1529)7.2.12 查询设备鉴权信息 (1534)7.2.13 发送命令 (1537)7.3 订阅管理 (1541)7.3.1 创建订阅管理 (1541)7.3.2 查询订阅管理信息 (1546)7.3.3 修改订阅管理 (1550)7.3.4 删除订阅管理 (1555)7.4 产品模板 (1558)7.4.1 创建产品模板 (1558)7.4.2 查询产品模板 (1563)7.4.3 删除产品模板 (1569)7.4.4 修改产品模板 (1573)7.5 产品管理 (1578)7.5.1 创建产品 (1578)7.5.2 查询产品 (1586)7.5.3 查询产品内设备数量 (1595)7.5.4 删除产品 (1598)7.5.5 查询产品详情 (1602)7.5.6 修改产品信息 (1608)7.5.7 添加产品主题 (1615)7.5.8 查询产品主题 (1620)7.5.9 删除产品主题 (1625)7.5.10 更新产品主题 (1628)7.5.11 重置产品鉴权信息 (1634)7.5.12 查询产品鉴权信息 (1638)7.5.13 导入产品 (1642)7.5.14 导出产品 (1645)7.6 规则引擎 (1649)7.6.1 创建规则 (1649)7.6.2 查询规则 (1655)7.6.3 批量删除规则 (1661)7.6.4 规则调试 (1665)7.6.5 删除规则 (1669)7.6.6 查询规则详情 (1672)7.6.8 添加目标数据源 (1684)7.6.9 查询目标数据源列表 (1690)7.6.10 删除目标数据源 (1695)7.6.11 添加源数据源 (1699)7.6.12 查询源数据源列表 (1704)7.6.13 删除源数据源 (1709)7.7 服务管理 (1712)7.7.1 创建服务 (1713)7.7.2 查询服务 (1718)7.7.3 删除服务 (1725)7.7.4 查询服务详情 (1728)7.7.5 修改服务 (1733)7.7.6 创建属性 (1739)7.7.7 查询属性 (1746)7.7.8 创建命令 (1752)7.7.9 查询命令 (1756)7.7.10 删除命令 (1761)7.7.11 查询命令详情 (1764)7.7.12 修改命令 (1768)7.7.13 创建请求属性 (1773)7.7.14 查询请求属性 (1780)7.7.15 删除请求属性 (1786)7.7.16 修改请求属性 (1789)7.7.17 创建响应属性 (1796)7.7.18 查询响应属性 (1803)7.7.19 删除响应属性 (1809)7.7.20 查询响应属性详情 (1812)7.7.21 修改响应属性 (1817)8 附录 (1825)8.1 获取项目ID (1825)8.2 获取租户ID (1826)8.3 状态码 (1826)8.4 错误码 (1827)8.4.1 公共资源API错误码 (1827)8.4.2 数据集成API错误码 (1836)8.4.3 服务集成API错误码 (1845)8.4.4 消息集成API错误码 (1874)8.4.5 设备集成API错误码 (1879)8.5 实例支持的APIC特性 (1920)8.6 数据集成参数说明 (1932)8.6.1 RawFormDataRequest (1932)8.7 获取数据源配置文件 (1955)8.7.1 MRS Hive (1955)8.7.2 MRS HDFS (1955)8.7.3 MRS HBase (1956)8.7.4 MRS Kafka (1956)9 历史API (1958)9.1 数据集成API（V1） (1958)9.1.1 数据集成任务 (1958)9.1.1.1 创建任务 (1958)9.1.1.2 删除任务 (1967)9.1.1.3 修改任务 (1968)9.1.1.4 查询指定任务的信息 (1972)9.1.1.5 查询任务列表 (1976)9.1.1.6 启动/停止任务 (1980)9.1.1.7 创建制定计划 (1982)9.1.1.8 修改制定计划 (1986)9.1.1.9 查询制定计划列表 (1989)9.1.1.10 查询指定任务的运行日志 (1992)9.1.1.11 查询指定任务的调度信息 (1995)9.1.1.12 导入任务 (2005)9.1.1.13 导出任务 (2010)9.1.2 数据源 (2016)9.1.2.1 创建数据源 (2016)9.1.2.2 修改数据源 (2034)9.1.2.3 删除数据源 (2038)9.1.2.4 查询数据源列表 (2039)9.1.2.5 导入数据源 (2043)9.1.2.6 导出数据源 (2048)9.1.2.7 测试数据源连接 (2052)9.1.3 连接器 (2068)9.1.3.1 查询指定连接器信息 (2068)9.2 服务集成API（V1） (2070)9.2.1 API分组管理（V1） (2070)9.2.1.1 创建API分组 (2070)9.2.1.2 修改API分组 (2076)9.2.1.3 删除API分组 (2082)9.2.1.4 查询分组详情 (2085)9.2.1.5 查询分组列表 (2090)9.2.2 API管理（V1） (2097)9.2.2.1 创建API (2097)9.2.2.2 修改API (2136)9.2.2.4 查询API详情 (2176)9.2.2.5 查询API列表 (2195)9.2.2.6 批量删除API (2209)9.2.2.7 批量发布或下线API (2213)9.2.2.8 调试API (2218)9.2.3 自定义后端服务（V1） (2223)9.2.3.1 查询后端API列表 (2223)9.2.3.2 创建后端API (2231)9.2.3.3 查询后端API详情 (2241)9.2.3.4 修改后端API (2248)9.2.3.5 删除后端API (2258)9.2.3.6 查询后端API测试结果 (2261)9.2.3.7 查询后端API部署历史 (2265)9.2.3.8 部署后端API (2273)9.2.3.9 测试后端API (2282)9.2.3.10 撤销后端API (2287)9.2.3.11 创建后端API脚本 (2290)9.2.4 APP授权管理（V1） (2298)9.2.4.1 APP授权 (2298)9.2.4.2 解除授权 (2304)9.2.4.3 查看APP已绑定的API列表 (2307)9.2.4.4 查看APP未绑定的API列表 (2313)9.2.4.5 查看API已绑定的APP列表 (2317)9.2.5 自定义认证管理（V1） (2322)9.2.5.1 创建自定义认证 (2323)9.2.5.2 修改自定义认证 (2328)9.2.5.3 删除自定义认证 (2334)9.2.5.4 查看自定义认证详情 (2337)9.2.5.5 查询自定义认证列表 (2341)9.3 消息集成API（V1） (2346)9.3.1 Topic管理 (2347)9.3.1.1 查询指定实例 (2347)9.3.1.2 查询所有实例列表 (2352)9.3.1.3 查询Topic (2358)9.3.1.4 批量删除Topic (2361)9.3.1.5 导入topic (2362)9.3.1.6 导出topic (2363)9.4 设备集成API（V1） (2364)9.4.1 产品管理 (2364)9.4.1.1 创建产品 (2364)9.4.1.2 查询产品列表 (2365)9.4.2.1 创建设备 (2367)9.4.2.2 创建设备自定义Topic (2369)9.4.2.3 查询设备列表 (2371)9.4.2.4 查询设备Topic列表 (2372)9.4.2.5 查询实例信息 (2374)9.4.3 规则引擎 (2375)9.4.3.1 创建规则引擎源端 (2375)9.4.3.2 创建规则引擎目的端 (2377)1使用前必读1.1 概述ROMA Connect是一个全栈式的应用与数据集成平台，提供消息、数据、API、设备等集成能力，简化企业上云，支持云上云下、跨区域集成，帮助企业实现数字化转型。
api接口文档
API协议文档（v0.03）目录一、前言 (4)（一）适用范围 (4)（二）定义、专业术语及缩略语 (4)二、协议格式说明 (5)（一）事项申明 (5)（二）请求格式 (5)（三）输出格式及时间、数组的说明 (6)三、协议 (7)●公共接口 (7)1.版本检查 (7)2.设备注册 ................................................................................................................................. 错误！未定义书签。
●B端.......................................................................................................................................... 错误！未定义书签。
3.登录 ......................................................................................................................................... 错误！未定义书签。
4.获取未处理预约数 ................................................................................................................. 错误！未定义书签。
5.获取验证码 ............................................................................................................................. 错误！未定义书签。
一、配置服务器，项目初始化，RPC接口
⼀、配置服务器，项⽬初始化，RPC接⼝服务器系统：centos7.6.18101. 安装软件1.1 gityum install git1.2 mysql安装命令yum install mysql-server提⽰未找到，则需要添加yum源，将从官⽹下载的mysql-community.repo放⼊/etc/yum.repos.1.3 虚拟环境安装virtualenv和virtualenvwrapper配置...创建虚拟环境2. 创建项⽬，码云建⽴仓库并上传创建项⽬cd /rootmkdir moguappcd moguapp# 创建flask项⽬启动⽂件manage.pyvim manage.py创建项⽬启动⽂件manage.py并写⼊代码：from flask import Flaskapp = Flask(__name__)@app.route('/')def index():return'hello here is index html'if__name__ == '__main__':app.run(host='0.0.0.0', port=5000)在终端下使⽤python manage.py运⾏测试服务器python manage.py浏览器访问结果到码云创建仓库，代码上传到码云在/root/moguapp/下进⾏以下步骤git config --global "yijue_lu"git config --global user.email "2117578083@"git initgit add .git commit -m "创建manage.py⽂件，写⼊基本代码，并成功运⾏"git remote add origin https:///yijue_lu/mogu.gitgit push -u origin master码云结果3. 项⽬初始化3.1 ⽬录结构建⽴如下⽬录结构moguapp/├─ logs/ # ⽇志⽂件存储⽬录├─ apps/ # 项⽬主要逻辑业务代码保存⽬录│├─ __init__.py # 项⽬初始化⽂件│├─ modules/ # 保存项⽬中所有api模块的存储⽬录││├─ common/ # 公共api接⼝⽬录│││├─ __init__.py # 公共api接⼝的初始化⽂件│││├─ models.py # 公共api接⼝的模型⽂件│││└─ api.py # 公共api接⼝代码⽂件││└─ __init__.py| ├─ utils/ # 项⽬⾃定义封装⼯具包⽬录| ├─ libs/ # 项⽬第三⽅⼯具包⽬录| ├─ settings/ # 项⽬配置存储⽬录││├─ dev.py # 开发阶段的配置⽂件││├─ prop.py # ⽣产阶段的配置⽂件││└─ __init__.py│└─ statics/ # 保存项⽬中所有的静态资源⽂件[img/css/js]└── manage.py # 项⽬的终端管理脚本⽂件3.2 写⼊配置信息写⼊基本配置信息到moguapp/apps/settings/__init__.pyimport redisclass Config(object):"""项⽬配置信息"""# 设置密钥，可以通过 base64.b64encode(os.urandom(48)) 来⽣成⼀个指定长度的随机字符串 SECRET_KEY = "T1vEjTCjkGon5vU8C6Xq3ujNSQgHQje"# 配置⽇志LOG_LEVEL = "DEBUG"# 调试模式DEBUG = True# 数据库的配置信息SQLALCHEMY_DATABASE_URI = "mysql://root:123@127.0.0.1:3306/mogu?charset=utf8" SQLALCHEMY_TRACK_MODIFICATIONS = TrueSQLALCHEMY_ECHO = True# redis配置REDIS_HOST = "127.0.0.1"REDIS_PORT = 6379SESSION_TYPE = "redis"# 指定 session 保存到 redis 中SESSION_USE_SIGNER = True # session_id 进⾏加密签名处理SESSION_REDIS = redis.StrictRedis( host=REDIS_HOST, port=REDIS_PORT,db=1 )PERMANENT_SESSION_LIFETIME = 24 * 60 * 60 # session 的有效期，单位是秒写⼊开发环境配置信息到moguapp/apps/settings/dev.pyfrom . import Configclass DevelopementConfig(Config):"""开发模式下的配置"""pass写⼊⽣产环境配置信息到moguapp/apps/settings/prop.pyfrom . import Configclass ProductionConfig(Config):"""⽣产模式下的配置"""DEBUG = FalseLOG_LEVEL = "INFO"SQLALCHEMY_TRACK_MODIFICATIONS = FalseSQLALCHEMY_ECHO = False3.3 配置项⽬⽇志把⽇志配置封装在init_log函数中，保存到utils/log.py⽂件import loggingfrom logging.handlers import RotatingFileHandler# 把⽇志相关的配置封装成⼀个⽇志初始化函数def init_log(Config):# 设置⽇志的记录等级logging.basicConfig(level=Config.LOG_LEVEL) # 调试debug级# 创建⽇志记录器，指明⽇志保存的路径、每个⽇志⽂件的最⼤⼤⼩、保存的⽇志⽂件个数上限file_log_handler = RotatingFileHandler("logs/log", maxBytes=1024 * 1024 * 300, backupCount=10) # 创建⽇志记录的格式⽇志等级输⼊⽇志信息的⽂件名⾏数⽇志信息formatter = logging.Formatter('%(levelname)s %(filename)s:%(lineno)d %(message)s')# 为刚创建的⽇志记录器设置⽇志记录格式file_log_handler.setFormatter(formatter)# 为全局的⽇志⼯具对象（flaskapp使⽤的）添加⽇志记录器logging.getLogger().addHandler(file_log_handler)3.4 项⽬初始化代码抽取在apps/__init__.py⽂件中，创建flask应⽤并加载配置from flask import Flaskfrom redis import StrictRedisfrom flask_session import Sessionfrom flask_sqlalchemy import SQLAlchemyfrom apps.settings.dev import DevelopementConfigfrom apps.settings.prop import ProductionConfigfrom apps.utils.log import init_logconfig = {"dev": DevelopementConfig,"prop": ProductionConfig,}# 预设全局变量db = SQLAlchemy()def init_app(config_name):"""项⽬的初始化功能"""app = Flask(__name__)# 设置配置类Config = config[config_name]# 加载配置app.config.from_object(Config)# redis的链接初始化global redis_storeredis_store = StrictRedis(host=Config.REDIS_HOST, port=Config.REDIS_PORT,db=0)# 开启session功能Session(app)# 配置数据库链接db.init_app(app)# 启动⽇志init_log(Config)return app3.5 配置项⽬启动⽂件修改manage.py启动⽂件，加载app初始化⼯⼚函数（from apps import init_app），并使⽤flask-script启动项⽬#from flask import Flaskfrom flask_script import Managerfrom flask_migrate import Migrate, MigrateCommandfrom apps import init_app,db#app = Flask(__name__)app = init_app("dev")# 使⽤终端脚本⼯具启动和管理flaskmanager = Manager(app)# 启⽤数据迁移⼯具Migrate(app, db)# 添加数据迁移的命令到终端脚本⼯具中manager.add_command('db', MigrateCommand)@app.route('/')def index():return'hello,moluo~'if__name__ == '__main__':#app.run(host=0.0.0.0, port=5000)manager.run()在终端重新使⽤manage.py启动项⽬python manage.py runserver --host=0.0.0.0 --port=50004. 基于Flask-JSONRPC提供RPC接⼝JSON-RPC是⼀个⽆状态的、轻量级的远程过程调⽤（RPC）协议。
U8移动应用服务器安装配置指南
U8移动应用服务器安装配置指南1.适用范围本文档适用于U8+ V11.1、V12.0移动应用服务器的安装配置。
2.V11.1安装移动应用服务器本环节适用于以下用户环境：●之前未使用移动应用产品的新用户实施●之前使用了旧版本移动服务器，需要进行版本升级或解决兼容性问题的用户环境2.1.安装前的准备工作2.1.1.旧版本服务器检查与卸载在U8+V11.1标准产品安装光盘中，包含了移动应用服务器的旧版本安装包，部分用户环境可能已安装了此版本的服务器。
因为后续版本迭代，旧版本服务器已不能跟新的客户端App保持兼容，在后续项目实施中，不再使用旧版本服务器安装包。
因此，在实施之前，需要检查用户环境是否已安装了旧版本服务器，如果已安装，需要先行卸载。
确认是否已安装过移动应用服务器：移动应用服务通常部署在U8应用服务器上，在U8应用服务器上检查相应的程序安装信息即可确认是否安装有移动服务器。
1.检查U8Soft目录中，是否有MAServer目录，如果没有，则表明未安装服务器；2.如果有MAServer目录，检查MAServer目录文件结构，旧版本目录结构如下所示：其中，显著的标志包括：目录中有ant、ejb、framework等子文件夹。
如果目录结构符合旧版本特征，需要先行卸载，卸载方法：在Windows “添加删除程序”或开始菜单中，选择相应的菜单或产品卸载快捷方式，并在卸载后按提示重启机器。
3.如果MAServer目录文件结构符合新版本特征，则表明已安装新的移动应用服务器版本，可不执行卸载，只需要更新相关补丁即可。
新版本服务器目录结构为：其中显著的特性包括：目录中包含tomcat子目录。
2.1.2.JDK安装配置U8移动应用服务器需要JDK 6及更新版本的支持。
安装之前，确认环境是否已安装了相应版本的JDK并作了正确的配置。
安装JDK：检查Windows“添加删除程序”中是否有“JAVA SE DevelopmetKit”相关程序项。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
UserName（用户名）
CircleID(圈子ID)
ID(帖子ID)
接口描述
删除帖子
返回值
成功:{"result":1,"message":”删除帖子成功”}
失败:{"result":0, "message":"删除帖子失败"}
7.
url
/books/mobile.zaction?command=replyPost
参数示例
json={"UserName":"xxx","CircleID":"xxx","ID":"xxx",
"deviceinfo":[{"SiteID":"33","AppVersion":"1.0","TerminalType":"IOS","SysVersion":"IOS5.1","Mac":"0E-A5-98-22-33","NetType":"Wifi","TerminalModel":"Lenovo A520","Resolution":"720*1280","AppType":"TCM"}]}
参数描述
UserName（用户名）
CircleID(圈子ID)
InfoID(Info表ID)可空
ID(回复表帖子ID)可空
Content(回复内容)
ToUser(收信人)可空(发送作业时,需要指定收信人)
Type 帖子类型
接口描述
回复帖子(InfoID和ID不能同时为空)
返回值
成功:{"result":1,"message":回复帖子成功}
人卫BBS接口文档
北京泽元迅长软件有限公司
2016年06月
文档更新历史
序号
文档版本
更新内容
参与者
更新日期
1
1.0
新增内容
郭可攀
2016-10-13
1.
url
/books/mobile.zaction?command=circleList
参数示例
"deviceinfo":[{"SiteID":"36","AppVersion":"1.0","TerminalType":"IOS","SysVersion":"IOS5.1","Mac":"0E-A5-98-22-33","NetType":"Wifi","TerminalModel":"Lenovo A520","Resolution":"720*1280","AppType":"TCM"}]}
"deviceinfo":[{"SiteID":"33","AppVersion":"1.0","TerminalType":"IOS","SysVersion":"IOS5.1","Mac":"0E-A5-98-22-33","NetType":"Wifi","TerminalModel":"Lenovo A520","Resolution":"720*1280","AppType":"TCM"}]}
参数描述
UserName(用户名)
ID(圈子ID)
Name(圈子名称)可空
Diescribe(圈子描述)可空
Status(审核状态(0:未审核 1:通过 2:未通过))可空
IsHidden(是否显示(0:否 1:是))可空
MaxCount(人数最多限制)可空
IsTop(是否置顶(0:否 1:是))可空
参数示例
json={"UserName":"xxx","CircleID":"xxx",
"deviceinfo":[{"SiteID":"33","AppVersion":"1.0","TerminalType":"IOS","SysVersion":"IOS5.1","Mac":"0E-A5-98-22-33","NetType":"Wifi","TerminalModel":"Lenovo A520","Resolution":"720*1280","AppType":"TCM"}]}
IsHidden(是否开放 )
FileBytes(文件流)可空
FileName(文件名称)可空
Users(学生包括关联老师名称)可空
接口描述
注意：新增圈子TZT要屏蔽显示(注：TZT代表通知/作业/讨论，下同)
如果是TZT传入Users/TeacherName建立圈子的同时把学生/老师加入圈子
返回值
参数描述
UserName（用户名）
CircleID(圈子ID)
接口描述
加入圈子
返回值
成功:{"result":1,"message":加入圈子成功}
失败:{"result":0, "message":"加入圈子失败"}
5.
url
/books/mobile.zaction?command=addPost
失败:{"result":0, "message":"获取圈子列表失败"}
2.
url
/books/mobile.zaction?command=addCircle
参数示例
json={"UserName":"xxx","Name":"xxx","Diescribe":"xxx","Source":"xxx","Type":"xxx","MaxCount":"100","Theme":"xxx",”IsHidden:””0”,"FileBytes":"xxx","FileName":"xxx","Users":"zhangsan;lisi",
参数描述
UserName（用户名）
ToUser(收信人)可空
CircleID(圈子ID)
Title(标题)
Content(内容)
Theme(内容载体(授课ID_课时ID或ISBN或空))可空
Type (类型(0:通知,1:讨论,2:作业,3:普通帖子)
Source 平台来源 (教学平台/电子书城/增值服务。。。不限)
接口描述
返回值
成功:{"result":1, "message":"发送帖子成功"}
失败:{"result":0, "message":"发送帖子失败"}
6.
url
/books/mobile.zaction?command=delPost
json={"UserName":"xxx","Source":"xxx","Type":"xxx","Theme":"xxx","PageSize":"10","PageIndex":"1"
"deviceinfo":[{"SiteID":"33","AppVersion":"1.0","TerminalType":"IOS","SysVersion":"IOS5.1","Mac":"0E-A5-98-22-33","NetType":"Wifi","TerminalModel":"Lenovo A520","Resolution":"720*1280","AppType":"TCM名)可空
Source(圈子来源)教学平台/电子书城/增值服务
Type(圈子类型) 交友/学习