Table of Contents

Neues image target erstellen | POST /targets

Laden Sie ein recognition image hoch und erstellen Sie ein neues image target.

Action

POST /targets

Authentication

Required

Http Header

Content-Type=application/json

HTTP Header: Authorization (bei Verwendung von API Key Token authentication)

Request parameters

Field Type Required Description
image String(base64) Yes Base64-encoded string des image content. JPG- und PNG-images werden unterstützt. Maximale image Größe: 2MB.
active String No "1" bedeutet target aktivieren, "0" bedeutet target deaktivieren. Default ist "1".
name String Yes Target name. Unterstützt werden nur englische Buchstaben, englische Satzzeichen und Ziffern. Mindestlänge 1 Zeichen, Maximallänge 64 Zeichen.
size String (Float) Yes Breite der recognition image (unit: cm). Die Höhe der recognition image wird vom System automatisch anhand der hochgeladenen image berechnet. Die Größe der recognition image entspricht der Größe des virtual content. Default 20.
meta String Yes Wird normalerweise verwendet, um AR content Informationen im text string Format zu speichern. Default ist "". Zum Beispiel: JSON information des erkannten Objekts, base64 encoding einer image oder URL download address einer großen Datei im cloud storage. Maximal 2MB.
type String (Float) Yes Muss fest als string "ImageTarget" konfiguriert werden. Groß-/Kleinschreibung muss exakt übereinstimmen.
allowSimilar String No Ob das Hinzufügen bei vorhandener similar image erzwungen erlaubt wird. Default 0. Similar images können recognition results beeinflussen, daher wird default empfohlen.
Anmerkung
  • maximales Limit für image: 2MB
  • maximales Limit für 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 bedeutet, dass authentication korrekt ist. Weitere Informationen unter Status codes
result Error message oder target image information
timestamp Server-side time beim Zurückgeben der response. Verwendet Unix timestamp format in Millisekunden
result.targetId Unique ID der target image
result.trackingImage Base64-encoded string der tracking image
result.name Target name
result.size Breite der recognition image (unit: cm). Die Höhe der recognition image wird vom System automatisch anhand der hochgeladenen image berechnet. Die Größe der recognition image entspricht der Größe des überlagerten virtual content
result.meta Base64-encoded additional information, z. B. der string, der durch base64-encoding eines json string erzeugt wird
result.type Fixed as ImageTarget
result.active "1" enabled, "0" disabled

Error codes

Siehe Vollständige Liste der status codes und error codes

Meta Verwendungshinweise

  • Video URL zuordnen
    • Für jedes recognition target können Sie die mit diesem spezifischen target verbundene video URL im meta field speichern
    • Nachdem Ihre Anwendung das target erkannt hat, verwenden Sie die URL in meta, um eine Verbindung zum Server herzustellen, das Video herunterzuladen und abzuspielen, z. B. https://my_server/my_videos/my_video_001.mp4
  • 3D model zuordnen
    • Für jedes recognition target können Sie ein meta field speichern, das ein 3D model oder Unity asset bundle enthält, das mit diesem spezifischen target verbunden ist
    • Sie müssen das model base64-encodieren und dann in meta speichern oder die URL des model in metadata speichern
    • Nachdem die Anwendung das target erkannt hat, rendert sie das 3D model auf dem detected target