创建识别目标 | POST /targets/

功能

创建新的图像目标

认证

请求参数:

字段名

类型

必须

描述

image

base64编码字符串

图像内容的base64编码字符串,支持JPG和PNG格式图像。图片最大2MB。

active

字符串(整数型的内容)

"1" 来启用目标,"0" 来停用目标。默认为 "1"

name

字符串

目标名称,仅支持英文字母、英文标点、数字,长度最小1个字符,最大64个字符

size

字符串(浮点型的内容)

识别图宽度(单位cm)。识别图的高度将由系统根据您上传的图片自动计算。识别图的大小和虚拟内容的大小对应。默认20

meta

字符串

一般用于存储AR内容信息,文本字符串格式,默认是""。 例如:识别物的JSON信息,图片的base64编码,或者是大文件在云存储的URL下载地址。最大2MB。

allowSimilar

字符串

如果存在相似图是否强制允许添加,默认0.相似图可能影响识别结果,建议采用默认。

type

字符串(浮点型的内容)

必须固定配置为字符串"ImageTarget",注意大小写需要完全一样。

注意:

您还可以传入任何其它字段,例如与目标相关的元数据,字符串类型。这些字段会在响应中原样返回。

例如,自定义resourceurl为目标图像的AR播放视频链接。

样例

POST /targets/ HTTP/1.1
Host:
Date: Mon, 1 Jan 2018 00:00:00 GMT
Content-Type: application/json
{
    "image":"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgM...",
    "active":"1",
    "name":"easyar",
    "size":"5",
    "meta":"496fbbabc2b38ecs3460a...",
    "type":"ImageTarget",
    "timestamp": 1514736000000,
    "appKey": "test_app_key",
    "signature": "89985e2420899196db5bdf16b3c2ed0922c0c221"
}

返回

HTTP/1.1 200 OK
Content-Type: application/json
{
    "statusCode": 0,
    "result": {
      "target": {
        "targetId":"e61db301-e80f-4025-b822-9a00eb48d8d2",
        "trackingImage":"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgM...",
        "name": "easyar",
        "size": "5",
        "meta": "496fbbabc2b38ecs3460a...",
        "type": "ImageTarget",
        "modified":1514735000000
        "active":"1",
        "trackableRate": 0,
        "detectableRate": 0,
        “detectableDistinctiveness”:0,
        "detectableFeatureCount", 0,
        "trackableDistinctiveness", 0,
        "trackableFeatureCount", 0,
        "trackableFeatureDistribution", 0,
        "trackablePatchContrast", 0,
        "trackablePatchAmbiguity", 0
      }
    },
    "timestamp": 1514736000000
}

返回说明:

statusCode:认证结果,0表示认证正确,1表示无效的应用秘钥,2表示无效的签名,3表示无效的日期

result:各个接口的返回结果在这里出现

timestamp:响应返回时的服务器端时间,用于在需要时调整需认证的请求中的时间

targetId:新目标的唯一ID

trackingImage:跟踪图像的base64编码字符串

name:目标名称,仅支持英文字母、英文标点、数字,长度最小1个字符,最大64个字符

size:识别图宽度(单位cm)。识别图的高度将由系统根据您上传的图片自动计算。识别图的大小和虚拟内容的大小对应。

meta:base64编码的附加信息,例如将json字符串base64编码后生成的字符串

type:固定为ImageTarget

active:"1"如果目标已经启用,否则为"0"

特别说明:

image: 文件最大2MB。尺寸推荐:最小64,最大4096

meta: 最大2MB

上传数据属性超过限制则返回错误

样例实现:

EasyAR为开发者提供了几个语言的 Target Management Samples,方便程序调用实现自动化: