Table of Contents

Создание нового image target | POST /targets

Загрузите recognition image и создайте новый image target.

Action

POST /targets

Authentication

Required

Http Header

Content-Type=application/json

HTTP Header: Authorization (при использовании API Key Token authentication)

Request parameters

Field Type Required Description
image String(base64) Yes Base64-encoded string содержимого image. Поддерживаются JPG и PNG images. Максимальный размер image - 2MB.
active String No "1" означает enable target, "0" означает disable target. Default - "1".
name String Yes Target name. Поддерживаются только английские буквы, английская пунктуация и цифры. Минимальная длина 1 символ, максимальная 64 символа.
size String (Float) Yes Ширина recognition image (unit: cm). Высота recognition image автоматически рассчитывается системой на основе загруженного image. Размер recognition image соответствует размеру virtual content. Default 20.
meta String Yes Обычно используется для хранения информации AR content в формате text string. Default - "". Например: JSON information распознаваемого объекта, base64 encoding изображения или URL download address большого файла в cloud storage. Максимум 2MB.
type String (Float) Yes Должно быть фиксированно задано как string "ImageTarget". Регистр должен полностью совпадать.
allowSimilar String No Принудительно ли разрешать добавление при наличии similar image. Default 0. Similar images могут повлиять на recognition results, поэтому рекомендуется default.
Примечание
  • максимальный лимит image: 2MB
  • максимальный лимит meta: 2MB

Request example

    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"
    }

Response example

    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
    }

Response fields

Field Description
statusCode Status code. 0 означает, что authentication корректна. Подробнее см. Status codes
result Error message или target image information
timestamp Server-side time при возврате response. Используется Unix timestamp format в миллисекундах
result.targetId Unique ID target image
result.trackingImage Base64-encoded string tracking image
result.name Target name
result.size Ширина recognition image (unit: cm). Высота recognition image автоматически рассчитывается системой на основе загруженного image. Размер recognition image соответствует размеру наложенного virtual content
result.meta Base64-encoded additional information, например string, созданная после base64-encoding json string
result.type Fixed as ImageTarget
result.active "1" enabled, "0" disabled

Error codes

См. Полный список status codes и error codes

Инструкции по использованию Meta

  • Связать video URL
    • Для каждого recognition target можно хранить video URL, связанный с этим конкретным target, в field meta
    • После того как приложение распознает target, используйте URL из meta для соединения с сервером, download и воспроизведения видео, например https://my_server/my_videos/my_video_001.mp4
  • Связать 3D model
    • Для каждого recognition target можно хранить field meta, содержащий 3D model или Unity asset bundle, связанный с этим конкретным target
    • Нужно выполнить base64 encoding model и сохранить ее в meta либо сохранить URL model в metadata
    • После распознавания target приложением 3D model будет rendered на detected target