API接口文档

合集下载

api接口说明文档模板文

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 接口文档 使用说明书

汉印云打印 开放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的。

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接口文档

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

API接口文档

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、接口调用地址domain/webmail/api/addDomain.php?adminpass=xxx&domain=abc.&quota=15000&userl imit=150&userquota=100&netfilequota=50&allowreg=on&created=2009-04-23&ended= 2013-01-01&password=1234562、传入参数需要以GET方式传递以下参数:●adminpass: 超级管理员MD5后的密码●domain: 要添加的域名,例如“abc.”●quota: 此域的空间限额,单位为M。

api接口文档

api接口文档

api接口文档
1、接口概述
接口概述主要说明本接口文档涉及到的业务功能点,面向的阅读对象以及接口文档主要包括哪些业务的接口,可以让读者有一个直观的认识。

如:本文档定义了中台系统面向外部接入方的数据协议接口,主要包括:用户注册接口、同步用户、授权认证等接口。

适合阅读的对象为接入中台开发者或者外部合作方…。

这样的一段描述,对于阅读者来说可以对整个接口文档有一个大概的认识。

2、权限说明
有的接口调用需要授权认证,在这部分需要进行说明。

如果接口只是基于分配的token认证,那文档需要说明token的获取方式。

如果接口需要进行签名认证,需要在这里说明签名的具体方法。

3、编码方式
接口的请求过程中可能由于编码导致乱码,所以,接口必须约定编码方式
4、请求说明
接口文档的请求说明中主要说明接口请求的域名以及请求的数据格式
5、接口列表
接口列表是接口文档的主要内容,这部分内容需要列出所有的接口名称、接口地址、接口的请求方式、接口的请求参数以及响应格式。


接口的请求参数中我们需要说明每个参数的含义、类型以及是否必须等属性。

对于接口响应结果,如果有业务字段,也需要进行说明。

6、状态码说明
接口的响应体一般都会带有响应的状态码,例如成功、失败等。

状态码有助于接入方进行接口调用状态的判断。

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接口是用于不同应用程序之间进行通信和交互的一种方式。

基本信息- 接口名称: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接口的简明文档,希望对开发人员有所帮助。

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

  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

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。

只能为数字,例如“15000”●userlimit: 限制的用户数,只能为数字,例如“150”●userquota: 默认用户空间限额,单位为M。

只能为数字,例如“100”●netfilequota: 默认网络文件柜限额,单位为M。

只能为数字,例如“50”●allowreg: 是否允许自由注册,“on”为允许,“off”为不允许●created: 域开通时间,格式为“2009-04-23”●ended: 域到期时间,格式为“2013-01-01”●password: 此域的域管理员密码,如没有此项密码默认为“12345678”●pwd_encode:(新增)此域的域管理员密码,如没有此项密码默认为“12345678”(base64加密)。

password,pwd_encode两个参数,优先取pwd_encode3、输出数据输出内容及含义如下:●param_error: 传递的参数错误●verify_error: 验证超级管理员密码错误●domain_exist: 已存在此域名●add_error: 添加域名出错●ok: 成功添加域名二、删除域名接口1、接口调用地址http://domain/webmail/api/delDomain.php?adminpass=xxx&domain= 2、传入参数需要以GET方式传递以下参数:●adminpass: 超级管理员MD5后的密码●domain: 要删除的域名,例如“”3、输出数据输出内容及含义如下:●param_error: 传递的参数错误●verify_error: 验证超级管理员密码错误●domain_not_exist: 不存在此域名●del_error: 删除域名出错●ok: 成功删除域名三、添加用户接口1、接口调用地址http://domain/webmail/api/addUser.php?adminname=admin&adminpass=xxx&mailbox= ************&password=11111&fullname=name&mailquota=100&filequota=502、传入参数需要以GET方式传递以下参数:●adminname: 域管理员名称●adminpass: 域管理员MD5后的密码●mailbox: 要添加的邮箱帐户全称,例如************●customdata: 自定义字段数据,如”10001”●password: 此帐户要设置的密码●pwd_encode:(新增)此帐户要设置的密码(base64加密)。

password,pwd_encode两个参数,优先取pwd_encode●fullname: 用户姓名(如果为中文字符请使用UTF-8格式,并进行URL 编码)●mailquota: 邮件空间限额,单位为“M”,只能为数字●filequota: 网络文件柜空间限额,单位为“M”,只能为数字3、输出数据输出内容及含义如下:●param_error: 传递的参数错误●verify_error: 域管理员验证错误●mailbox_exist: 已存在此邮箱●add_error: 添加邮箱错误●数字: 成功添加邮箱返回用户id值四、获取用户信息接口1、接口调用地址使用邮箱名称调用(未开启自定义用户字段功能):http://domain/webmail/api/userInfo.php?adminname=admin&adminpass=xxx&mai lbox=************使用自定义字段调用:http://domain/webmail/api/userInfo.php?adminname=admin&adminpass=xxx&dom ain=&cfv=xxx2、传入参数需要以GET方式传递以下参数:●adminname: 域管理员名称●adminpass: 域管理员MD5后的密码●mailbox: 取得信息的邮箱帐户全称,例如“************”●cfv: 自定义字段对应值,例如学号“100001”●domain: 自定义字段对应用户所在的域名名称,例如“”3、输出数据正常情况下输出的信息为XML,其格式如下:<?xml version="1.0" encoding="UTF-8" ?><user><email>************</email><name><![CDATA[用户姓名]]></name><password>用户密码</password><custom_value><![CDATA[自定义用户字段对应值]]></custom_value></user>出现错误的时候输出内容为字符串,输出类型及其含义如下:●param_error: 传递的参数错误●verify_error: 域管理员验证错误●mailbox_not_exist: 不存在此邮箱五、搜索用户接口1、接口调用地址http://domain/webmail/api/searchUser.php?domain=&adminname=admin&adm inpass=xxx&keyword=user2、传入参数需要以GET方式传递以下参数:●domain: 要搜索用户的邮箱域●adminname: 域管理员名称●adminpass: 域管理员MD5后的密码●keyword: 搜索关键字,为UTF-8编码,需进行URL Encode转换。

相关文档
最新文档