云识别接口

【文档说明】

使用接口前需要先到开发者平台进行如下操作：

注册：https://cloud.voidar.net/develop/registerp
登录：https://cloud.voidar.net/develop/loginp
新建云数据库，取得该数据库的accessKey和apiKey。

【接口说明】

接口均使用http post方式访问，请求参数和返回结果均为json格式，并且需要在http header中增加项“Authorization”进行访问权限设置，格式为“accessKey:apiKey”，还需要增加项“Content-Length”进行请求数据长度设置，具体使用可参考接口演示程序。

接口演示程序下载：WebapiDemo.zip (3.74 MB)

Note

演示程序使用说明：安装jdk1.8和eclipse，然后将演示工程导入eclipse (File->Import...->General->Existing Projects into Workspace->Next)，即可运行。

1.上传识别图

接口说明：上传单张识别图到指定的云数据库

接口地址：https://cloud.voidar.net/develop/ws/uploadTarget.do

请求参数：

名称	类型	必要	备注
name	string	Y	图片名称，不能为空，最大长度50字符。
metadata	string	Y	自定义数据，可以为空，需要进行base64编码，最大长度2000字符。
imagedata	string	Y	图片数据，不能为空，需要进行base64编码，大小最大为2M。

Json数据：

{"name":"10.jpg","metadata":"dGVzdA...","imagedata":"4AAQSkZJRgA..."}

返回结果：

成功：

{
	"code":"0",//返回代码，0表示成功
	"msg":"上传成功",//返回信息
	"image":{//图片详细信息
		"id":3521,//图片ID
		"name":"10.jpg",//名称
		"metadata":"test",//自定义数据
		"rating":5,//识别度评分（1-差 2-较差 3-中 4-较好 5-好）
		"bundle":"0,0,0,0",//是否绑定assetbundle（ios,android,windows,mac），							等于0表示没有绑定，大于0表示已绑定
		"createTime":"2016-03-30 14:11:19"//上传时间
	}
}

失败：

{
	"code":"1",//返回代码，1表示失败
	"msg":"图片上传失败"//失败描述
}

演示程序：AddTarget.java

2.取得识别图列表

接口说明：从云数据库取得指定数量的识别图信息

接口地址：https://cloud.voidar.net/develop/ws/targetList.do

请求参数：

名称	类型	必要	备注
start	int	Y	记录开始位置
num	int	Y	记录数量，最大值为20

Json数据：

{"start":0,"num":10}

返回结果：

成功：

{
	"code":"0",//返回代码，0表示成功
	"msg":"",//返回信息
	"total":1,//图片总数
	"data":[{//图片详细信息
		"id":3521,//图片ID
		"name":"10.jpg",//名称
		"metadata":"test",//自定义数据
		"rating":5,//识别度评分（1-差 2-较差 3-中 4-较好 5-好）
		"bundle":"0,0,0,0",//是否绑定assetbundle（ios,android,windows,mac），							等于0表示没有绑定，大于0表示已绑定
		"createTime":"2016-03-30 14:11:19"//上传时间
	}]
}

失败：

{
	"code":"1",//返回代码，1表示失败
	"msg":"请求数据传输错误"//失败描述
}

演示程序：TargetList.java

3.上传assetbundle

接口说明：上传unity打包的assetbundle文件到云数据库，并与指定图片绑定

接口地址：https://cloud.voidar.net/develop/ws/uploadBundle.do

请求参数：

名称	类型	必要	备注
id	long	Y	图片ID
platform	int	Y	平台1-ios 2-android 3-windows 4-mac
bundle	string	Y	assetbundle数据，不能为空，需要进行base64编码，大小最大为2M

Json数据：

{"id":3521,"platform":1,"bundle":"VW5pdHlXZ..."}

返回结果：

成功：

{
	"code":"0",//返回代码，0表示成功
	"msg":"assetbundle上传成功"//返回信息
}

失败：

{
	"code":"1",//返回代码，1表示失败
	"msg":"请求数据传输错误"//失败描述
}

演示程序：UploadBundle.java

4.取得识别图详细信息

接口说明：从云数据库取得指定识别图的信息

接口地址：https://cloud.voidar.net/develop/ws/targetDetail.do

请求参数：

名称	类型	必要	备注
id	long	Y	图片ID

Json数据：

{"id":3521}

返回结果：

成功：

{
	"code":"0",//返回代码，0表示成功
	"msg":"",//返回信息
	"image":{//图片详细信息
		"id":3521,//图片ID
		"name":"10.jpg",//名称
		"metadata":"test",//自定义数据
		"rating":5,//识别度评分（1-差 2-较差 3-中 4-较好 5-好）
		"bundle":"2,0,0,0",//是否绑定assetbundle（ios,android,windows,mac），							等于0表示没有绑定，大于0表示已绑定
		"createTime":"2016-03-30 14:11:19"//上传时间
	}
}

失败：

{
	"code":"1",//返回代码，1表示失败
	"msg":"请求数据传输错误"//失败描述
}

演示程序：TargetDetail.java

5.删除识别图

接口说明：从云数据库删除指定识别图

接口地址：https://cloud.voidar.net/develop/ws/deleteTarget.do

请求参数：

名称	类型	必要	备注
id	long	Y	图片ID

Json数据：

{"id":3521}

返回结果：

成功：

{
	"code":"0",//返回代码，0表示成功
	"msg":"删除成功"//返回信息
}

失败：

{
	"code":"1",//返回代码，1表示失败
	"msg":"请求数据传输错误"//失败描述
}

演示程序：DelTarget.java

6.删除assetbundle

接口说明：删除指定图片绑定的assetbundle

接口地址：https://cloud.voidar.net/develop/ws/deleteBundle.do

请求参数：

名称	类型	必要	备注
id	long	Y	图片ID
platform	int	Y	平台1-ios 2-android 3-windows 4-mac

Json数据：

{"id":3521,"platform":1}

返回结果：

成功：

{
	"code":"0",//返回代码，0表示成功
	"msg":"删除assetbundle成功"//返回信息
}

失败：

{
	"code":"1",//返回代码，1表示失败
	"msg":"请求数据传输错误"//失败描述
}

演示程序：DelBundle.java

7.更新自定义数据

接口说明：更新指定图片的metadata

接口地址：https://cloud.voidar.net/develop/ws/updateMetadata.do

请求参数：

名称	类型	必要	备注
id	long	Y	图片ID
metadata	string	Y	自定义数据，可以为空，需要进行base64编码，最大长度200字符。

Json数据：

{"id":3521,"metadata":test}

返回结果：

成功：

{
	"code":"0",//返回代码，0表示成功
	"msg":"更新自定义数据成功"//返回信息
}

失败：

{
	"code":"1",//返回代码，1表示失败
	"msg":"请求数据传输错误"//失败描述
}

演示程序：UpdateMetadata.java

8.根据名称取得识别图详细信息

接口说明：从云数据库根据名称取得识别图的信息

接口地址：https://cloud.voidar.net/develop/ws/targetDetailByName.do

请求参数：

名称	类型	必要	备注
name	string	Y	图片名称

Json数据：

{"name":"case1"}

返回结果：

成功：

{
	"code":"0",//返回代码，0表示成功
	"msg":"",//返回信息
	"image":{//图片详细信息
		"id":3521,//图片ID
		"name":"10.jpg",//名称
		"metadata":"test",//自定义数据
		"rating":5,//识别度评分（1-差 2-较差 3-中 4-较好 5-好）
		"bundle":"2,0,0,0",//是否绑定了assetbundle（ios,android,windows,mac），						等于0表示没有绑定，大于0表示已绑定
		"createTime":"2016-03-30 14:11:19"//上传时间
	}
}

失败：

{
	"code":"1",//返回代码，1表示失败
	"msg":"请求数据传输错误"//失败描述
}

演示程序：TargetDetailByName.java

9.code说明

code	备注
0	成功
1	失败
401	权限错误（accessKey或apiKey错误）
999	系统错误