Crear un nuevo image target | POST /targets

Suba una recognition image y cree un nuevo image target.

Action

POST /targets

Authentication

Required

Http Header

Content-Type=application/json

HTTP Header: Authorization (cuando se usa API Key Token authentication)

Request parameters

Field	Type	Required	Description
image	String(base64)	Yes	String codificado en base64 del image content. Se admiten images en formato JPG y PNG. Tamaño máximo de la image: 2MB.
active	String	No	"1" significa enable target, "0" significa disable target. El default es "1".
name	String	Yes	Target name. Solo admite letras inglesas, puntuación inglesa y dígitos. Longitud mínima 1 carácter, máxima 64 caracteres.
size	String (Float)	Yes	Ancho de la recognition image (unit: cm). La altura de la recognition image se calcula automáticamente por el sistema según la image que suba. El tamaño de la recognition image corresponde al tamaño del virtual content. Default 20.
meta	String	Yes	Normalmente se usa para almacenar información de AR content en formato text string. El default es "". Por ejemplo: JSON information del objeto reconocido, base64 encoding de una image, o URL download address de un archivo grande en cloud storage. Máximo 2MB.
type	String (Float)	Yes	Debe configurarse de forma fija como el string "ImageTarget". La distinción de mayúsculas y minúsculas debe coincidir exactamente.
allowSimilar	String	No	Si se permite forzosamente agregar cuando existe una similar image. Default 0. Similar images pueden afectar recognition results, por lo que se recomienda el default.

Nota

• límite máximo de image: 2MB
• límite máximo de 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 significa que authentication es correcta. Para más información, consulte Status codes
result	Error message o target image information
timestamp	Server-side time cuando se devuelve la response. Usa Unix timestamp format en milisegundos
result.targetId	Unique ID de la target image
result.trackingImage	String codificado en base64 de la tracking image
result.name	Target name
result.size	Ancho de la recognition image (unit: cm). La altura de la recognition image se calcula automáticamente por el sistema según la image que suba. El tamaño de la recognition image corresponde al tamaño del overlaid virtual content
result.meta	Additional information codificada en base64, como el string generado tras base64-encoding de un json string
result.type	Fixed as ImageTarget
result.active	"1" enabled, "0" disabled

Error codes

Consulte Lista completa de status codes y error codes

Instrucciones de uso de Meta

• Asociar un video URL
  • Para cada recognition target, puede almacenar en el field meta el video URL asociado con ese target específico
  • Después de que su aplicación reconoce el target, use el URL en meta para conectarse al servidor, descargar y reproducir el video, por ejemplo https://my_server/my_videos/my_video_001.mp4
• Asociar un 3D model
  • Para cada recognition target, puede almacenar un field meta que contenga un 3D model o Unity asset bundle asociado con ese target específico
  • Debe codificar el model en base64 y luego almacenarlo en meta, o almacenar el URL del model en metadata
  • Después de que la aplicación reconoce el target, renderiza el 3D model sobre el detected target