Table of Contents

创建新的图像目标 | POST /targets

上传识别图像，创建新的图像目标

Action

POST /targets

认证

需要

Http Header

Content-Type=application/json

HTTP Header: Authorization (当采用 API Key Token 方式认证)

请求参数

Field Type Required Description
image String(base64) Yes 图像内容的 base64 编码字符串，支持 JPG 和 PNG 格式图像。图片最大 2MB。
active String No "1" 表示启用目标，"0" 表示停用目标。默认为 "1"。
name String Yes 目标名称，仅支持英文字母、英文标点、数字，长度最小 1 个字符，最大 64 个字符。
size String（Float） Yes 识别图宽度(单位 cm )。识别图的高度将由系统根据您上传的图片自动计算。识别图的大小和虚拟内容的大小对应。默认 20。
meta String Yes 一般用于存储 AR 内容信息，文本字符串格式，默认是""。 例如：识别物的 JSON 信息，图片的 base64 编码，或者是大文件在云存储的 URL 下载地址。最大 2MB。
type String (Float) Yes 必须固定配置为字符串 "ImageTarget"，注意大小写需要完全一样。
allowSimilar String No 如果存在相似图是否强制允许添加，默认 0。相似图可能影响识别结果，建议采用默认。
注意
  • image 限制最大 2MB
  • meta 限制最大 2MB

请求示例

    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 表示认证正确，更多参考 状态码
result 错误消息，或者目标图信息
timestamp 响应返回时的服务器端时间。使用 Unix 时间戳格式，以毫秒为单位
result.targetId 目标图的唯一 ID
result.trackingImage 跟踪图像的 base64 编码字符串
result.name 目标名称
result.size 识别图宽度（单位 cm ）。识别图的高度将由系统根据您上传的图片自动计算。识别图的大小和叠加虚拟内容的大小对应
result.meta base64 编码的附加信息，例如将 json 字符串 base64 编码后生成的字符串
result.type 固定为 ImageTarget
result.active "1" 启用，"0" 停用

错误码

参见 状态码以及错误码大全

Meta 使用说明

  • 关联视频 URL
    • 对于每个识别目标，您可以存储包含与该特定目标关联的视频 URL，关联在 meta 字段里
    • 在您的应用识别目标后，使用 meta 中的 URL 连接到服务器，下载并播放视频, 例如 https://my_server/my_videos/my_video_001.mp4
  • 关联 3D 模型
    • 对于每个识别目标，您可以存储包含 3D 模型或 Unity 资源包以与该特定目标关联的 meta 字段
    • 需要使用 base64 编码模型再存储在 meta 中，或者在元数据中存储模型的 URL
    • 当应用识别目标后，会在检测到的目标上渲染 3D 模型