Table of Contents

Ricerca riconoscimento obiettivo| POST /v2/search

Cerca obiettivi immagine, interfaccia di riconoscimento ricerca per immagine.

Azione

POST /v2/search

Autenticazione

Richiesta

Intestazione Http

Content-Type : multipart/form-data

Authorization (solo quando si utilizza l'autenticazione tramite token API Key)

Parametri di richiesta

Campo Tipo Obbligatorio Descrizione
image Multipart Stringa codificata base64 del contenuto dell'immagine, supporta immagini in formato JPG e PNG.
notracking Stringa No "false" indica che restituisce l'immagine di tracking trackingImage. "true" indica che restituisce solo l'attributo targetId rilevato, senza l'immagine di tracking. Per WebAR si consiglia di includerlo per ridurre la latenza delle richieste.

Esempio di richiesta con autenticazione Token

curl -X POST -H "Authorization:xxx"  --form "image=@trackingImage.jpg;type=image/jpg"  --form appId=YOUR-APPID 
          https://<your-domain>-cn1.crs.easyar.com:8443/v2/search

Esempio di richiesta con autenticazione firma

curl -X POST --form "image=@trackingImage;type=image/jpg" 
              --form apiKey=YOUR-APIKEY  --form appId=YOUR-APPID 
              --form timestamp=1514736000000 
              --form signature=xxx 
          https://<your-domain>-cn1.crs.easyar.com:8443/v2/search
Importante
  • È necessario utilizzare Client-end-URL come punto di ingresso per il riconoscimento, https utilizza la porta 8443
  • Impostare l'intestazione http Connection: Keep-Alive per ottimizzare il sovraccarico delle connessioni ripetute

Campi restituiti

Campo Descrizione
statusCode Codice di stato 0 indica autenticazione corretta, per maggiori informazioni vedere Codici di stato
result Messaggio di errore o informazioni sull'immagine obiettivo
timestamp Tempo del server al momento della risposta. Utilizza il formato timestamp Unix, in millisecondi
result.targetId ID univoco dell'immagine obiettivo
result.trackingImage Stringa codificata base64 dell'immagine di tracking
result.name Nome dell'obiettivo
result.size Larghezza dell'immagine di riconoscimento (unità cm). L'altezza verrà calcolata automaticamente dal sistema in base all'immagine caricata. La dimensione dell'immagine di riconoscimento corrisponde alla dimensione del contenuto virtuale sovrapposto
result.meta Informazioni aggiuntive codificate base64, ad esempio una stringa generata codificando in base64 una stringa json
result.type Fisso su ImageTarget
result.active "1" abilitato, "0" disabilitato

Principali codici di ritorno

Risposta CODICE HTTP Stato Risultato
OK 200 0 result: { imageBody }
NO_RESULT 404 17 result: { message: "No result: there is no matching." }
NO_TARGET 500 18 result: { message: "Target not found: there is a matching but no target, please report this issue: IMAGE-UUID" }
TIMEOUT 408 19 result: { message: "Request timeout." }
OUT_OF_LIMIT 402 21 result: { message: "You have exceeded the limit of daily scanning." }
OUT_OF_QPS 200 21 result: { message: "Exceed your QPS limitation." }
RPC_ERROR 500 20 result: { message: "Error retrieving results." }
OTHER_ERROR 501 30 result: { message: "Other error occur: details" }

Codici di errore

Vedi Codici di stato ed elenco completo errori

Esempio di richiesta

POST /search/ HTTP/1.1
Host:
Date: Mon, 1 Jan 2018 00:00:00 GMT
Content-Type: application/json
{
    "image":"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgM...",
    "timestamp": 1514736000000,
    "appKey": "test_app_key",
    "signature": "89985e2420899196db5bdf16b3c2ed0922c0c221"
}

Esempio di risposta

  • Se viene riconosciuto un match, la struttura restituita è:

    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
    }

  • Se non ci sono immagini obiettivo corrispondenti, la risposta è:

    HTTP/1.1 404 NOT FOUND
    Content-Type: application/json
    {
      "statusCode": 17,
      "result": {
        "message": "No result: there is no matching."
      }
    }