Creare un nuovo image target | POST /targets

Caricare una recognition image e creare un nuovo image target.

Action

POST /targets

Authentication

Required

Http Header

Content-Type=application/json

HTTP Header: Authorization (quando si usa API Key Token authentication)

Request parameters

Field	Type	Required	Description
image	String(base64)	Yes	String base64-encoded del image content. Sono supportate images in formato JPG e PNG. Dimensione massima image: 2MB.
active	String	No	"1" significa enable target, "0" significa disable target. Default "1".
name	String	Yes	Target name. Supporta solo lettere inglesi, punteggiatura inglese e cifre. Lunghezza minima 1 carattere, massima 64 caratteri.
size	String (Float)	Yes	Larghezza della recognition image (unit: cm). L'altezza della recognition image viene calcolata automaticamente dal sistema in base alla image caricata. La dimensione della recognition image corrisponde alla dimensione del virtual content. Default 20.
meta	String	Yes	Di solito usato per memorizzare informazioni di AR content in formato text string. Default "". Ad esempio: JSON information dell'oggetto riconosciuto, base64 encoding di una image, oppure URL download address di un file grande in cloud storage. Massimo 2MB.
type	String (Float)	Yes	Deve essere configurato fisso come string "ImageTarget". La distinzione tra maiuscole e minuscole deve corrispondere esattamente.
allowSimilar	String	No	Se permettere forzatamente l'aggiunta quando esiste una similar image. Default 0. Similar images possono influenzare recognition results, quindi si consiglia il default.

Nota

• limite massimo image: 2MB
• limite massimo 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 che authentication è corretta. Per ulteriori informazioni, vedere Status codes
result	Error message o target image information
timestamp	Server-side time quando viene restituita la response. Usa Unix timestamp format in millisecondi
result.targetId	Unique ID della target image
result.trackingImage	String base64-encoded della tracking image
result.name	Target name
result.size	Larghezza della recognition image (unit: cm). L'altezza della recognition image viene calcolata automaticamente dal sistema in base alla image caricata. La dimensione della recognition image corrisponde alla dimensione del virtual content sovrapposto
result.meta	Additional information base64-encoded, ad esempio la string generata dal base64-encoding di una json string
result.type	Fixed as ImageTarget
result.active	"1" enabled, "0" disabled

Error codes

Vedere Elenco completo di status codes ed error codes

Istruzioni per l'uso di Meta

• Associare un video URL
  • Per ogni recognition target, è possibile memorizzare nel field meta il video URL associato a quello specifico target
  • Dopo che l'applicazione riconosce il target, usare la URL in meta per connettersi al server, download e riprodurre il video, ad esempio https://my_server/my_videos/my_video_001.mp4
• Associare un 3D model
  • Per ogni recognition target, è possibile memorizzare un field meta contenente un 3D model o Unity asset bundle associato a quello specifico target
  • È necessario eseguire base64-encoding del model e poi memorizzarlo in meta, oppure memorizzare la URL del model nei metadata
  • Dopo che l'applicazione riconosce il target, renderizza il 3D model sul detected target