API文档地址

http://localhost/webedit/api/wiki/

3.4.0以上版本

API使用配置

1. 打开API应用管理页面: http://localhost/webedit/APIApplicationList.aspx

2. 新建应用程序以获得API授权Key

3. 使用Key和Username作为授权参数依据API文档进行相关API的调用，企业版Username固定为Ebanswers

API调用说明

调用地址风格

传统风格：

地址模板：api/category/resources/action

以action指定api功能，需指定改功能支持的http method访问方式

如action为list时表示获取列表数据，改功能通常只支持get访问方式

restful风格

单个资源:api/category/resources/entry

集合: api/category/resources/feed

以entry或feed区分资源集范围，以http method访问方式指定功能

如以entry指定单个资源范围，以delete方式配合id参数指定删除功能

默认参数说明

format

所有API都支持该参数，指定以哪种数据格式返回API结果，目前支持xml和json

start_index

所有list类API都支持该参数，表示列表数据从第几个记录开始获取

count

所有list类API都支持该参数，表示列表数据获取的数量，默认为20

sort_field

所有list类API都支持该参数，表示列表数据以哪个字段排序

sort_order

所有list类API都支持该参数，表示列表数据排序的方式，asc：递增，desc：递减

API调试工具

访问地址

http://localhost/webedit/api/wiki/TestTool.aspx

使用说明

API导航

左侧为系统所有API的导航链接，

授权信息

目前企业版只提供openid&openkey的授权方式，在授权信息中的appkey请填写新建的应用程序所获得的授权key，appsecret为用户名参数username，企业版为固定值:Ebanswers

请求地址

API的请求地址和请求方式配置

Cookies list

暂未启用

参数设置

默认已为调试的API创建了匹配的参数，此处可自行对参数进行配置，如添加返回格式参数format:xml，其中文件参数用于素材上传等接口

结果信息

点击”发送请求”后，指定API的调用结果将在此处显示

示例

以获取在线终端列表为例，接口调用示例如下

Javascript

$.ajax({

url: “http://localhost/webedit/api/player/players/list”,

type:”GET”,

cache: false,

dataType: “json”,

data: {

key:”key”, //授权的APP Key

username:”Ebanswers”,

status:1 //状态为在线

success: successFunction,

error: errorFunction

})

Function successFunction(result){

//…

}

Function errorFunction(result){

//…

}

C#

string apiUrl = string.Format("{0}?key={1}&username={2}&status=1", “http://localhost/webedit/api/player/players/list”, “key”,”Ebanswers”);

string result = webClient.DownloadString(apiUrl);

…

以上信息是否解决了您的问题
是
否
提交