Créer une nouvelle image target | POST /targets

Uploader une recognition image et créer une nouvelle image target.

Action

POST /targets

Authentication

Required

Http Header

Content-Type=application/json

HTTP Header: Authorization (lorsque l'authentication API Key Token est utilisée)

Request parameters

Field	Type	Required	Description
image	String(base64)	Yes	String encodée en base64 du image content. Les images aux formats JPG et PNG sont prises en charge. Taille maximale de l'image : 2MB.
active	String	No	"1" signifie enable target, "0" signifie disable target. La valeur default est "1".
name	String	Yes	Target name. Seuls les lettres anglaises, la ponctuation anglaise et les chiffres sont pris en charge. Longueur minimale 1 caractère, maximale 64 caractères.
size	String (Float)	Yes	Largeur de la recognition image (unit: cm). La hauteur de la recognition image est calculée automatiquement par le système selon l'image uploadée. La taille de la recognition image correspond à la taille du virtual content. Default 20.
meta	String	Yes	Généralement utilisé pour stocker les informations AR content au format text string. La valeur default est "". Par exemple : JSON information de l'objet reconnu, base64 encoding d'une image, ou URL download address d'un grand fichier dans cloud storage. Maximum 2MB.
type	String (Float)	Yes	Doit être configuré de manière fixe comme la string "ImageTarget". La casse doit correspondre exactement.
allowSimilar	String	No	Indique s'il faut autoriser de force l'ajout lorsqu'une similar image existe. Default 0. Les similar images peuvent affecter les recognition results, la valeur default est donc recommandée.

Note

• limite maximale de image : 2MB
• limite maximale 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 signifie que l'authentication est correcte. Pour plus d'informations, consultez Status codes
result	Error message ou target image information
timestamp	Server-side time au moment où la response est retournée. Utilise Unix timestamp format en millisecondes
result.targetId	Unique ID de la target image
result.trackingImage	String encodée en base64 de la tracking image
result.name	Target name
result.size	Largeur de la recognition image (unit: cm). La hauteur de la recognition image est calculée automatiquement par le système selon l'image uploadée. La taille de la recognition image correspond à la taille du virtual content superposé
result.meta	Additional information encodée en base64, par exemple la string générée par base64-encoding d'une json string
result.type	Fixed as ImageTarget
result.active	"1" enabled, "0" disabled

Error codes

Voir Liste complète des status codes et error codes

Instructions d'utilisation de Meta

• Associer une video URL
  • Pour chaque recognition target, vous pouvez stocker dans le field meta la video URL associée à ce target spécifique
  • Après que votre application a reconnu le target, utilisez l'URL dans meta pour vous connecter au serveur, download et lire la vidéo, par exemple https://my_server/my_videos/my_video_001.mp4
• Associer un 3D model
  • Pour chaque recognition target, vous pouvez stocker un field meta contenant un 3D model ou un Unity asset bundle associé à ce target spécifique
  • Vous devez encoder le model en base64 puis le stocker dans meta, ou stocker l'URL du model dans les metadata
  • Une fois le target reconnu par l'application, elle rend le 3D model sur le detected target