api接口技术文档

三、统一sign签名的生成规则 1、签名待加密字符串为key，timestamp，param组成的Json
如： {"key":"xxxxxx","timestamp":1533630832,"param":null} 2、MD5签名规则 32位加密,每个字节转化为大写16进制并且输出2位四、统一返回Json格式
api接口技术文档
目录一、基本说明 (2) 二、统一Form表单参数 (2) 三、统一sign签名的生成规则 (3) 1、签名待加密字符串为key，timestamp，param组成的Json (3) 2、MD5签名规则 (3) 四、统一返回Json格式 (3) 五、部门接口 (4) 1、部门类ApiDept (4) 2、Url和Param (5) 3、调用示例 (6) 六、人员接口 (7) 1、人员类ApiUser (7) 2、Url和Param (8) 3、调用示例 (9) 一、基本说明 1、协议：http 2、请求方式：post 3、数据提交方式：Form表单提交 4、Accept：text/html 5、ContentType：application/x-www-form-urlencoded 6、返回格式：Json 二、统一Form表单参数
五、部门接口 1、部门类ApiDept
ser 2、Url和Param 3、调用示例

API接口文档

API接口文档最后更新日期：2013-05-16一、添加域名接口 (6)1、接口调用地址 (6)2、传入参数 (6)3、输出数据 (6)二、删除域名接口 (7)1、接口调用地址 (7)2、传入参数 (7)3、输出数据 (7)三、添加用户接口 (8)1、接口调用地址 (8)2、传入参数 (8)3、输出数据 (8)四、获取用户信息接口 (9)1、接口调用地址 (9)2、传入参数 (9)3、输出数据 (9)五、搜索用户接口 (10)1、接口调用地址 (10)2、传入参数 (10)3、输出数据 (10)六、修改用户接口 (11)1、接口调用地址 (11)2、传入参数 (11)3、输出数据 (12)七、删除用户接口 (13)1、接口调用地址 (13)2、传入参数 (13)3、输出数据 (13)八、获取邮箱别名接口 (14)1、接口调用地址 (14)2、传入参数 (14)3、输出数据 (14)九、获取部门列表接口 (15)1、接口调用地址 (15)2、传入参数 (15)3、输出数据 (15)十、添加部门接口 (17)1、接口调用地址 (17)3、输出数据 (17)十一、修改部门接口 (18)1、接口调用地址 (18)2、传入参数 (18)3、输出数据 (18)十二、删除部门接口 (19)1、接口调用地址 (19)2、传入参数 (19)3、输出数据 (19)十三、获取部门成员接口 (20)1、接口调用地址 (20)2、传入参数 (20)3、输出数据 (20)十四、添加部门成员接口 (21)1、接口调用地址 (21)2、传入参数 (21)3、输出数据 (21)十五、删除部门成员接口 (22)1、接口调用地址 (22)2、传入参数 (22)3、输出数据 (22)十六、添加别名接口 (23)1、接口调用地址 (23)2、传入参数 (23)3、输出数据 (23)十七、修改别名接口 (24)1、接口调用地址 (24)2、传入参数 (24)3、输出数据 (24)十八、删除别名接口 (25)1、接口调用地址 (25)2、传入参数 (25)3、输出数据 (25)十九、获取POP接收邮件接口 (26)1、接口调用地址 (26)2、传入参数 (26)3、输出数据 (26)二十、添加POP接收邮件接口 (27)1、接口调用地址 (27)2、传入参数 (27)3、输出数据 (27)二十一、修改POP接收邮件接口 (28)1、接口调用地址 (28)3、输出数据 (28)二十二、删除POP接收邮件接口 (29)1、接口调用地址 (29)2、传入参数 (29)3、输出数据 (29)二十三、获取邮件列表接口 (30)1、接口调用地址 (30)2、传入参数 (30)3、输出格式 (30)二十四、查看邮件接口 (31)1、调用方式 (31)2、传入参数 (31)3、输出格式 (31)二十五、客户端连机检测接口 (32)1、接口调用地址 (32)2、传入参数 (32)3、输出数据 (32)二十六、单点登录 (33)1、登录方法 (33)2、传入参数 (34)二十七、冻结/解冻用户帐号接口 (36)1、接口调用地址 (36)2、传入参数 (36)3、输出数据 (36)二十八、获取冻结用户帐号接口 (37)1、调用方式 (37)2、传入参数 (37)3、输出格式 (37)二十九、获取显示已存在的邮件列表接口 (37)1、调用方式 (37)2、传入参数 (37)3、输出格式 (37)三十、添加邮件列表接口 (38)1、调用方式 (38)2、传入参数 (38)3、输出格式 (38)三十一、修改邮件列表接口 (38)1、调用方式 (38)2、传入参数 (39)3、输出格式 (39)三十二、删除邮件列表接口 (39)1、调用方式 (39)3、输出格式 (39)三十三、显示邮件列表成员接口 (40)1、调用方式 (40)3、输出格式 (40)三十四、添加邮件列表成员接口 (40)1、调用方式 (40)2、传入参数 (41)3、输出格式 (41)三十五、删除邮件列表成员接口 (41)1、调用方式 (41)2、传入参数 (41)3、输出格式 (41)三十六、更新邮件列表成员属性接口 (42)1、调用方式 (42)2、传入参数 (42)3、输出格式 (42)三十七、获取个人通讯录分组列表* (42)1、调用方式 (42)2、传入参数 (42)3、输出格式 (43)三十八、获取个人通讯录指定分组下的联系人列表* (43)1、调用方式 (43)2、传入参数 (43)3、输出格式 (44)三十九、获取个人通讯录联系人信息* (44)1、调用方式 (44)2、传入参数 (45)3、输出格式 (45)四十、添加个人通讯录分组* (46)1、调用方式 (46)2、传入参数 (46)3、输出格式 (46)四十一、修改个人通讯录分组* (47)1、调用方式 (47)2、传入参数 (47)3、输出格式 (47)四十二、删除个人通讯录分组* (48)1、调用方式 (48)2、传入参数 (48)3、输出格式 (48)四十三、添加联系人* (48)1、调用方式 (48)2、传入参数 (49)3、输出格式 (49)四十四、修改联系人* (50)1、调用方式 (50)2、传入参数 (50)3、输出格式 (51)四十五、删除联系人* (51)1、调用方式 (51)2、传入参数 (51)3、输出格式 (51)四十六、添加联系人分组信息* (52)1、调用方式 (52)2、传入参数 (52)3、输出格式 (53)四十七、删除联系人分组信息* (53)1、调用方式 (53)2、传入参数 (53)3、输出格式 (54)一、添加域名接口1、接口调用地址http://domain/webmail/api/addDomain.php?adminpass=xxx&domain=&quota=1 5000&userlimit=150&userquota=100&netfilequota=50&allowreg=on&created=2009-04 -23&ended=2013-01-01&password=1234562、传入参数需要以GET方式传递以下参数：●adminpass: 超级管理员MD5后的密码●domain: 要添加的域名，例如“”●quota: 此域的空间限额，单位为M。

95306铁路api接口文档

95306铁路api接口文档摘要：1.95306 铁路API 接口概述2.API 接口功能模块3.API 接口使用注意事项4.API 接口的申请与使用流程5.API 接口的未来发展趋势正文：【95306 铁路API 接口概述】95306 铁路API 接口，即中国铁路95306 客户服务中心提供的应用程序编程接口，旨在为开发者提供一种便捷、高效的方式，以实现与铁路客户服务中心系统的数据交互。

通过使用这些API 接口，开发者可以轻松地为自己的应用程序添加铁路票务查询、预订、改签等实用功能。

【API 接口功能模块】95306 铁路API 接口主要包括以下功能模块：1.票务查询：包括查询列车时刻表、余票信息、票价等；2.票务预订：支持预订火车票、退票等操作；3.票务改签：提供火车票改签服务；4.订单查询：查询用户历史订单信息；5.用户管理：包括用户注册、登录、个人信息管理等功能。

【API 接口使用注意事项】在使用95306 铁路API 接口时，需要注意以下几点：1.遵守相关法律法规，确保应用内容合法合规；2.API 接口仅提供数据查询和处理功能，不涉及资金交易；3.请勿恶意使用API 接口，如刷票、抢票等行为；4.使用API 接口时，需要确保数据安全，防止数据泄露。

【API 接口的申请与使用流程】1.申请API 接口：开发者需先在中国铁路95306 客户服务中心官方网站注册账号，并在线填写API 接口申请表，提交相关资料；2.审核：95306 客户服务中心将对申请进行审核，审核通过后，开发者将获得API 接口的访问权限；3.开发与测试：开发者利用API 接口进行应用开发与测试；4.上线运行：应用开发完成后，可上线运行，为用户提供服务。

api接口说明文档模板文

api接口说明文档模板文API是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件的以访问一组例程的能力今天小编给大家整理了api知识供大家参考，我们一起来看看吧!api接口说明文档模板1API：应用程序接口(API：Application Program Interface)应用程序接口是一组定义、程序及协议的集合，通过API 接口实现计算机软件之间的相互通信。

API 的一个主要功能是提供通用功能集。

程序员通过调用API 函数对应用程序进行开发，可以减轻编程任务。

API 同时也是一种中间件，为各种不同平台提供数据共享。

根据单个或分布式平台上不同软件应用程序间的数据共享性能，可以将 API 分为四种类型：远程过程调用(RPC)：通过作用在共享数据缓存器上的过程(或任务)实现程序间的通信。

标准查询语言(SQL)：是标准的访问数据的查询语言，通过数据库实现应用程序间的数据共享。

文件传输：文件传输通过发送格式化文件实现应用程序间数据共享。

信息交付：指松耦合或紧耦合应用程序间的小型格式化信息，通过程序间的直接通信实现数据共享。

当前应用于 API 的标准包括 ANSI 标准 SQL API。

另外还有一些应用于其它类型的标准尚在制定之中。

API 可以应用于所有计算机平台和操作系统。

这些 API 以不同的格式连接数据(如共享数据缓存器、数据库结构、文件框架)。

每种数据格式要求以不同的数据命令和参数实现正确的数据通信，但同时也会产生不同类型的错误。

因此，除了具备执行数据共享任务所需的知识以外，这些类型的API 还必须解决很多网络参数问题和可能的差错条件，即每个应用程序都必须清楚自身是否有强大的性能支持程序间通信。

相反由于这种API 只处理一种信息格式，所以该情形下的信息交付API 只提供较小的命令、网络参数以及差错条件子集。

正因为如此，交付API 方式大大降低了系统复杂性，所以当应用程序需要通过多个平台实现数据共享时，采用信息交付 API 类型是比较理想的选择。

开发接口文档API文档模板

版本控制信息版本日期描绘作者2018-8-13创立XXX获得全部字段1.1获得全部字段恳求地点：/session/field/findAll恳求参数参数名必填字段种类描绘name 是String 依据名称挑选响应code 10000成功，-1系统错误，10001必填参数为空message 响应描绘result 如响应例子恳求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统办理正常！","page":0,"pageSize":0,"returnObject":null,"returnValue":{"types":null,"villages":nu ll,"companys":[{"iconColour":"","iconSize":0,"iconStyle":"","id":4,"name":"XX"},{"iconColour":"","iconSize": 0,"iconStyle":"","id":5,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":7,"name":"XX"}]},"tot als":0}文件上传2.1文件上传（ajax）恳求地点：/session/file/upload恳求参数参数名必填字段种类描绘file 是FormData FormData对象包括的文件响应code 10000成功，-1系统错误，10001必填参数为空message 响应描绘result 如响应例子恳求例子：varformData=newFormData(); ("file",[0]);$.ajax({url:routePath+"/session/file/upload", type:'POST',data:formData,processData:false,contentType:false,success:function(result){result=(result);if=="10000"){ ('上传成功！');editHeadPortrait").val} }});响应例子：returnValue 里包括了fileName 和filePath字段管理-所属种类3.1新增所属种类恳求地点：/session/fieldType/save恳求参数参数名必填字段种类描绘name 是String 所属种类名称响应code 10000成功，-1系统错误，10001必填参数为空message 响应描绘result 如响应例子恳求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统办理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"to tals":0}3.2改正所属种类恳求地点：/session/fieldType/update恳求参数参数名必填字段种类描绘id 是Long 所属种类idname 是String 所属种类名称响应code 10000成功，-1系统错误，10001必填参数为空message 响应描绘result 如响应例子恳求例子：&name=test响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":" 成功，系统办理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"to tals":0}3.3依据id获得所属种类恳求地点：/session/fieldType/getById恳求参数参数名必填字段种类描绘id 是Long 所属种类id响应code 10000成功，-1系统错误，10001必填参数为空message 响应描绘result 如响应例子恳求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统办理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":{"id":2, "name":"re"},"totals":0}3.4获得所属种类列表恳求地点：/session/fieldType/selectAll恳求参数参数名必填字段种类描绘name 否String 依据种类名称挑选响应code 10000成功，-1系统错误，10001必填参数为空message 响应描绘result 如响应例子恳求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统办理正常！","page":0,"pageSize":0,"returnObject":null,"returnValue":[{"id":1,"name":"123"},{"id ":6,"name":"145555"}],"totals":2}3.5删除所属种类（批量）恳求地点：/session/fieldType/deleteByIds恳求参数参数名必填字段种类描绘ids 是List 所属种类id会合响应code 10000成功，-1系统错误，10001必填参数为空message 响应描绘result 如响应例子恳求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统办理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"t otals":0}。

汉印云打印开放API 接口文档使用说明书

【汉印云打印】开放API接口文档版本(1.1)2018年10月汉印云打印平台.接口文档V1.1目录1.概述： (1)2.打印接口： (1)2.1API接口地址 (1)2.2API请求方式 (1)2.3API调用方法 (1)2.4系统级和应用级的参数 (2)2.5签名加密算法如下： (3)2.6加密示例： (3)2.7需要传递给API的参数是： (3)3.APP调用功能： (4)3.1添加打印机 (4)3.2删除打印机 (5)3.3打印订单 (6)3.4查询打印机状态 (7)3.5查询打印完成情况 (8)4.内容排版标记参数 (10)5.注意事项 (13)6.版本信息： (14)1.概述：汉印云打印平台是以互联网为基础，整合云打印机资源，构建漫游共享的打印平台，向所有用户提供随时随地高质量、标准化的打印服务，包含了云平台、API、云打印服务器、云打印机等，产品广泛应用于快递业、超市、餐饮、社区店、生鲜店等，并致力于成为国内一线互联网云平台。

本文档提供了面向互联网开放的API接口，可有效的实现汉印云打印平台和应用开发者之间的对接，帮助用户和开发者方便地使用云平台的架构和功能。

2.打印接口：本节介绍如何发送数据到汉印云API并通过云平台输出打印指令，以及对应的状态返回码。

2.1API接口地址/api/values2.2API请求方式POST2.3API调用方法发送打印数据到汉印云API请求以及参数应该用POST方法发送。

汉印云API将根据收到的信息验证请求的有效性反馈对应的状态码。

2.4系统级和应用级的参数发送打印数据到汉印云请求必须包含以下参数（系统级参数和应用级参数）。

系统级参数应用级参数2.5签名加密算法如下：Sign=MD5（UserID+PrinterNo+TimeStamp+ApiKey)，串在一起后进行MD5加密然后再转成大写，括号里面的参数只需要传入值。

2.6加密示例：000001hcs100171600521498469357ED93DC463FA44A7F8BD1919AE282C 310这是未加密前串在一起的排列，然后把这串字符进行MD5加密得到的结果就是sign的值Sign=MD5（UserID+PrinterNo+TimeStamp+ApiKey)2.7需要传递给API的参数是：UserID、PrinterNo、TimeStamp这3个参数是需要提交给API的。

接口技术文档doc

快递鸟接口(API)技术文档版本日期版本说明作者2014-12-01 3.0 重新整理，根据功能分类，部分有调整杨文胜2014-01-11 3.1 对接口的说明进行了注释，提高可读性杨汉汶2014-01-13 3.2 新增推送接口杨汉汶2015-03-11 3.3 新增批量订阅推送接口，删除3.2版本推送接口杨文胜2015-10-12 3.4 新增订单分发接口，整理电子面单接口曹强2016-01-19 3.5 重新调整在线下单接口曹强2016-03-01 3.6 增加智选物流接口曹强2016-03-01 3.7 分发及订阅接口更新任海洋2016-04-07 3.7.1 推送接口更新任海洋2016-05-11 3.7.2 电子面单新增通知快递员上门字段，推送接口新增货款状态推送詹益伟2016-07-01 4.0 全新4.0接口，新增单号识别接口、智选物流接口、更新物流轨迹接口（订阅查询）詹益伟2016-9-26 4.0.1 推送接口新增DataSign字段、订阅2.0新增仓库标识ID、智选物流接口新增字段胡蕾蕾2016-11-03 4.1 新增在途监控（增值服务）曹强2016-12-13 4.1.1 电子面单新增第三方订单号ThrOrderCode胡蕾蕾2017-1-10 4.2 新增隐私快递胡蕾蕾2017-2-16 4.2.1 新增代收货款业务胡蕾蕾2017-4-13 4.3 1、即时查询接口中轨迹状态新增0-无轨迹2、普通回调接口中删除201状态3、修改智选物流接口文档4、电子面单接口添加特殊字符提示陈爱2017-4-25 4.4 1、新增申请电子面单客户号接口2、新增电子面单余额查询接口3、新增电子面单单号回收接口4、新增申请客户号信息推送接口陈爱2017-6-22 4.5 新增短信接口李旭安2017-7-14 4.6 电子面单接口新增支持邮政快递包裹吴明名词定义必须要求说明R 必填（Required）。

特斯拉api接口文档

特斯拉api接口文档特斯拉API接口文档特斯拉公司是一家专注于电动汽车、太阳能产品和能源存储解决方案的公司。

特斯拉提供了一系列的API接口，使得开发者可以更加自由地与特斯拉的产品进行交互。

1. 概述特斯拉API接口是基于RESTful架构的，可以通过HTTP/HTTPS 进行通信。

目前支持的API包括：车辆API、充电站API、驾驶数据API、能源产品API等。

2. 车辆API车辆API允许开发者对特斯拉车辆进行控制，包括锁车、开关车窗、控制车灯等。

同时，还可以获取车辆的状态信息，包括车辆位置、电量、剩余里程等。

3. 充电站API充电站API允许开发者查询特斯拉公司官方认证的充电站信息。

开发者可以获取充电站的位置、充电速率、充电费用等信息，以便于用户选择最优的充电站。

4. 驾驶数据API驾驶数据API允许开发者获取车辆的驾驶数据，包括车速、加速度、转向角度等信息。

同时，还可以获取车辆的行驶路线、高度变化等信息，用于创建驾驶记录和导航应用。

5. 能源产品API能源产品API允许开发者查询特斯拉的太阳能板、Powerwall等能源产品的状态信息。

开发者可以获取能源产品的电量、充电速率、剩余使用时间等信息，以便于用户更好地管理能源。

6. 认证和安全特斯拉API使用OAuth2.0认证机制，保证了用户数据的安全性。

同时，特斯拉API还支持SSL加密，确保数据在传输过程中不会被窃取或篡改。

7. 使用限制为了保护用户数据的安全性和服务质量，特斯拉API设置了一些使用限制。

例如，车辆API的请求次数和频率都有限制，充电站API 和驾驶数据API的查询结果也有数量限制。

8. 开发者文档特斯拉API提供了详细的开发者文档，包括API接口说明、认证流程、使用限制等内容。

开发者可以在特斯拉开发者门户网站上注册账号，获取API的访问权限和开发文档。

总结特斯拉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接口文档中的规范和限制，以实现更高效和安全的应用开发。

API接口文档(精简版)

API接口文档(精简版)API接口文档（精简版）1. 简介该文档提供了有关API接口的详细信息，包括接口功能、请求参数、返回结果等内容。

开发人员可以通过此文档了解如何正确调用API接口，并获取所需的数据或实现特定功能。

2. 接口列表以下是可用的API接口列表：- 接口1：功能描述1接口1：功能描述1- 接口2：功能描述2接口2：功能描述2- 接口3：功能描述3接口3：功能描述33. 接口1该接口实现了功能描述1。

以下是该接口的详细信息。

3.1 请求URLGET /api/interface13.2 请求参数该接口不需要任何请求参数。

3.3 返回结果该接口返回以下结果。

{"result": "success","message": "接口调用成功","data": {"field1": "value1","field2": "value2"}}4. 接口2该接口实现了功能描述2。

以下是该接口的详细信息。

4.1 请求URLPOST /api/interface24.2 请求参数该接口需要以下请求参数。

4.3 返回结果该接口返回以下结果。

{"result": "success", "message": "接口调用成功", "data": {"field1": "value1","field2": "value2"}}5. 接口3该接口实现了功能描述3。

以下是该接口的详细信息。

5.1 请求URLPUT /api/interface3/{id}5.2 请求参数该接口需要以下请求参数。

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;。

NPAPI接口库技术说明文档

NPAPI插件技术说明文档说明：该文档主要说明基于NPAPI标准进行开发浏览器插件的方法和开发环境等的相关说明。

并以简单的例子实现在firefox、Opera和chrome浏览器上测试进行说明。

主要说明原理性的内容。

一、环境说明：VS2008 + xulrunner-1.9.2.17.en-US.win32.sdkSDK是firefox提供的，下载地址/en/docs/Gecko_SDK需要用到firefox源码中的例子插件的一些源码文件：np_entry.cpp、npn_gate.cpp、npp_gate.cpp、basic.def、pluginbase.h、npplat.h、plugin.h等文件。

二、函数说明：NP_是npapi的插件库提供给浏览器的最上层的接口NPP_即NP Plugin是插件本身提供给浏览器调用的接口，主要被用来填充NPPluginFuncs的结构体NPN_即NP Netscape ,是浏览器提供给插件使用的接口，这些接口一般都在NPNetscapeFuncs结构体中1)NP_XXX类函数NP_XXX类接口一般为动态链接库的导出接口，主要有NP_Initialize、NP_GetMIMEDesc ription、NP_GetEntryPoints、NP_GetValue、NP_Shutdown的等几个函数，不同平台的接口可能略有不同，但基本功能都是一样的，都是通过接口来初始化、销毁以及认知此动态库。

详细的接口介绍请参照：https:///en/Gecko_Plugin_API_Reference:Plug-in_Side_Plug-in_API2)NPP_XXX类函数NPP_XXX类接口一般为提供给浏览器引擎调用的接口，主要包括：NPP_New、NPP_Destroy、NPP_SetWindow、NPP_GetMIMEDescription、NPP_NewStream、N PP_DestroyStream、NPP_StreamAsFile、NPP_WriteReady、NPP_Write、NPP_Print、NPP_Hand leEvent、NPP_URLNotify、NPP_GetValue、NPP_SetValue等详细的接口介绍请参照：https:///en/Gecko_Plugin_API_Reference:Plug-in_Side_Plug-in_API3)NPN_XXX类函数NPN_XXX类接口一般为webkit引擎提供给plugin调用的接口主要包括：NPN_GetURL、NPN_PostURL、NPN_RequestRead、NPN_NewStream、NPN_Write、NPN_De stroyStream、NPN_Status、NPN_UserAgent、NPN_MemAlloc、NPN_MemFree、NPN_Me mFlush、NPN_ReloadPlugins、NPN_GetJavaEnv、NPN_GetJavaPeer、NPN_GetURLNotify、NPN_PostURLNotify、NPN_GetValue、NPN_SetValue、NPN_InvalidateRect、NPN_Invalidat eRegion、NPN_ForceRedraw、NPN_GetStringIdentifier、NPN_GetStringIdentifiers、等详细接口请参照：https:///en/Gecko_Plugin_API_Reference:Browser_Side_Plug-in_API和https:///en/Gecko_Plugin_API_Reference/Scripting_plugins4)重要函数结构说明①NPError NPP_New(NPMIMEType pluginType,//插件提供给浏览器的识别信息，浏览器解析HTML时根据该表示来调用和加载插件NPP instance,//插件实例uint16 mode,//插件模式①NP_EMBED:嵌入浏览器页面模式；②NP_FULL：独占页面模式int16 argc,//<embed>参数个数char *argn[],//<embed>参数名称char *argv[],//<embed>参数值NPSavedData *saved)//存放一些浏览器发来页面信息，在下次打开同一页面时可以直接使用{}②char* NP_GetMIMEDescription(void){Return（MIME_TYPES_DESCRIPTION）；}char* NPP_ NP_GetMIMEDescription(void){Return（MIME_TYPES_DESCRIPTION）；}MIME_TYPES_DESCRIPTION是插件类型，可以指定一个的或多个，一个类型是通常对MIME_TYPES_DESCRIPTION进行宏定义：#define MIME_TYPES_DESCRIPTION “application(vedio)/basic-plugin：[要处理的文件类型（.avi）]：[name插件名称]”多个类型是采用直接在return里面并列列出：③NPError NPP_SetWindow(NPP instance,// 当前插件的实例NPWindow *window);//指向插件绘制的窗口，包含窗口句柄，宽高左上角左边等信息④void *NPN_MemAlloc (uint32 size);void *NPN_MemFree (uint32 size);用来调用插件时向浏览器申请内存和销毁插件时释放内训⑤NPError NP_GetValue(Void * instance,//指向当前插件实例NPPVariable variable,// 两个变量①NPPVpluginNameString:插件名称；②NPPVpluginDescriptionString:插件描述Void * value)//上述变量的值三、插件生命周期三、简单插件例子通过添加一个函数来实现在插件绘制的窗口上打印一串字符：如果调用应用程序能可以直接在插件实例初始化的时候进行调用，可以自己定义函数。

手机充值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查询接口输入：参数名类型备注param1String手机号码输出：参数名类型备注customerName String客户名称balance String余额或缴费金额等belongTo String归属地2.4下单接口输入：参数名类型备注param1String手机号码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接口文档。

95306铁路api接口文档

95306铁路API接口文档1. 简介95306铁路API接口是为了方便用户获取中国铁路相关信息而设计的开放接口。

通过该接口，用户可以查询车次信息、余票情况、车站信息等。

本文档将详细介绍95306铁路API接口的使用方法和参数说明，帮助用户快速上手并正确使用该接口。

2. 接口列表95306铁路API接口包括以下几个主要的功能模块：•车次查询•余票查询•车站查询•线路查询•城市查询下面将依次介绍每个功能模块的具体接口和参数。

2.1 车次查询接口名称：/train/query/trainNo/{trainNo}请求方式： GET请求参数：参数名类型是否必填描述trainNo string 是车次代号date string 否出发日期from string 否出发城市to string 否到达城市pageIndex int 否分页索引返回结果：{"status": "success","data": {"trainNo": "G1234","from": "北京","to": "上海","startTime": "08:00","endTime": "12:00","duration": "4小时",...}}返回字段说明：•status：请求状态，值为”success”或”error”•data：返回的车次信息•trainNo：车次代号•from：出发城市•to：到达城市•startTime：出发时间•endTime：到达时间•duration：行程时长接口名称：/train/query/station/{station}请求方式： GET请求参数：参数名类型是否必填描述station string 是车站名date string 否出发日期pageIndex int 否分页索引返回结果：{"status": "success","data": [{"trainNo": "G1234","from": "北京","to": "上海",...},...]}返回字段说明：与车次查询接口相同。

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接口文档模板，希望开发者在编写接口文档时能够按照该模板进行规范化的操作，以便更好地进行接口的使用和维护。

同时，也希望在实际使用中能够不断完善和优化该模板，使其更符合实际需求。

api接口文档

API协议文档（v0.03）目录一、前言 (4)（一）适用范围 (4)（二）定义、专业术语及缩略语 (4)二、协议格式说明 (5)（一）事项申明 (5)（二）请求格式 (5)（三）输出格式及时间、数组的说明 (6)三、协议 (7)●公共接口 (7)1.版本检查 (7)2.设备注册 ................................................................................................................................. 错误！未定义书签。

●B端.......................................................................................................................................... 错误！未定义书签。

3.登录 ......................................................................................................................................... 错误！未定义书签。

4.获取未处理预约数 ................................................................................................................. 错误！未定义书签。

5.获取验证码 ............................................................................................................................. 错误！未定义书签。

API接口文档(简明版)

API接口文档(简明版)概述本文档提供了对API接口的简明描述，旨在帮助开发人员理解和使用API接口。

API接口是用于不同应用程序之间进行通信和交互的一种方式。

基本信息- 接口名称：API接口- 版本号：1.0请求方法API接口支持以下请求方法：- GET：用于获取资源的信息- POST：用于创建资源- PUT：用于更新资源- DELETE：用于删除资源接口地址API接口的地址如下：接口参数API接口支持以下参数：- 参数1：用于...- 参数2：用于...返回结果API接口返回的结果采用JSON格式，示例如下：{"code": 200,"message": "请求成功","data": {"id": 1,"name": "John Doe",}}错误处理- 400：请求参数错误- 401：未授权访问- 404：资源不存在- 500：服务器内部错误示例代码以下是使用API接口的示例代码：import requestsresponse = requests.get(url)if response.status_code == 200:data = response.json()print(data)else:print("Error:", response.status_code)授权信息使用API接口需要进行身份验证。

请联系管理员获取授权信息，并在请求中包含相应的授权头信息。

其他注意事项- 请遵循相关的API使用规范和最佳实践，以实现良好的开发体验。

以上是API接口的简明文档，希望对开发人员有所帮助。

如有任何疑问，请联系技术支持团队。

西部数码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接口发布，采用新的接口地址，格式跟老版本不兼容。

快递鸟接口技术文档说明书

快递鸟接口(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接口服务，满足不同用户的物流管理需求。

api接口技术文档