api接口技术文档
api接口技术文档
如： {"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="a=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接口为开发者提供了丰富的数据和控制能力，有助于开发更加智能、便捷的特斯拉电动汽车应用。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
目录
一、基本说明 (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表单参数
三、统一sign签名的生成规则
1、签名待加密字符串为key，timestamp，param组成的Json
如：
{"key":"xxxxxx","timestamp":1533630832,"param":null}
2、MD5签名规则
32位加密,每个字节转化为大写16进制并且输出2位四、统一返回Json格式
五、部门接口
1、部门类ApiDept
2、Url和Param
3、调用示例
六、人员接口
1、人员类ApiUser
2、Url和Param
3、调用示例。