Table of Contents

Modifier les propriétés de l'image cible | PUT /target/<target_id>

Modifie les propriétés de l'image cible correspondant au target_id. Utilise une modification de paramètres au format Http patch, les paramètres inchangés restent intacts.

Action

PUT /target/<target_id>

Authentification

Requis

Http header

Content-Type=application/json

HTTP Header: Authorization (lors de l'authentification par jeton API Key)

Paramètres de requête

Field Type Required Description
image String(base64) Oui Chaîne encodée en base64 du contenu de l'image, prend en charge les formats JPG et PNG. Taille maximale de l'image : 2 Mo.
active String Non "1" pour activer la cible, "0" pour la désactiver. Par défaut "1".
name String Oui Nom de la cible, uniquement des lettres anglaises, ponctuation anglaise, chiffres. Longueur minimale 1 caractère, maximale 64 caractères.
size String(Float) Oui Largeur de l'image de reconnaissance (en cm). La hauteur sera calculée automatiquement par le système en fonction de l'image téléchargée. La taille de l'image de reconnaissance correspond à celle du contenu virtuel. Par défaut 20.
meta String Oui Généralement utilisé pour stocker des informations de contenu AR, format chaîne de texte, par défaut "". Exemple : informations JSON de l'objet, encodage base64 d'une image, ou URL de téléchargement d'un fichier volumineux dans le stockage cloud. Max 2 Mo.
type String (Float) Oui Doit être configuré comme la chaîne "ImageTarget", respecter strictement la casse.
allowSimilar String Non Si des images similaires existent, autoriser ou non l'ajout forcé, par défaut 0. Les images similaires peuvent affecter la reconnaissance, il est recommandé d'utiliser la valeur par défaut.
Note
  • image limité à 2 Mo maximum.
  • meta limité à 2 Mo maximum.

Exemple de requête

    PUT /target/e61db301-e80f-4025-b822-9a00eb48d8d2 HTTP/1.1
    Host:
    Date: Mon, 1 Jan 2018 00:00:00 GMT
    Content-Type: application/json
    {
        "active":"1",
        "name":"easyar",
        "size":"5",
        "meta":"496fbbabc2b38ecs3460a...",
        "timestamp": 1514736000000,
        "appKey": "test_app_key",
        "signature": "89985e2420899196db5bdf16b3c2ed0922c0c221"
    }

Exemple de réponse

    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",
            "date": "2016-06-15T09:56:30.000Z",
            "active":"1",
            "trackableRate": 0,
            "detectableRate": 0,
            "detectableDistinctiveness":0,
            "detectableFeatureCount": 0,
            "trackableDistinctiveness": 0,
            "trackableFeatureCount": 0,
            "trackableFeatureDistribution": 0,
            "trackablePatchContrast": 0,
            "trackablePatchAmbiguity": 0
          }
        },
        "timestamp": 1514736000000
    }

Champs de retour

Champ Description
statusCode Code d'état 0 indique une authentification correcte, voir Codes d'état
result Message d'erreur ou informations sur l'image cible
timestamp Heure du serveur au moment de la réponse. Format Unix timestamp en millisecondes
result.targetId ID unique de l'image cible
result.trackingImage Chaîne encodée en base64 de l'image de suivi
result.name Nom de la cible
result.size Largeur de l'image de reconnaissance (en cm). La hauteur est calculée automatiquement par le système. La taille correspond à celle du contenu virtuel superposé
result.meta Informations supplémentaires encodées en base64, par exemple une chaîne JSON encodée en base64
result.type Fixé à ImageTarget
result.active "1" activé, "0" désactivé

Codes d'erreur

Voir Liste complète des codes d'état et d'erreur