Table of Contents

Erkennungsziel suchen | POST /v2/search

Sucht image target, eine recognition-Schnittstelle zur Bildsuche per Bild.

Action

POST /v2/search

Authentifizierung

Erforderlich

Http Header

Content-Type : multipart/form-data

Authorization (nur bei Authentifizierung mit API Key Token)

Anfrageparameter

Field Type Required Description
image Multipart Yes Base64 encoding-String des Bildinhalts, unterstützt Bilder im JPG- und PNG-Format.
notracking String No "false" bedeutet, dass trackingImage zurückgegeben wird. "true" bedeutet, dass nur die erkannte targetId-Eigenschaft zurückgegeben wird und kein tracking image. Für WebAR wird empfohlen, diesen Parameter standardmäßig mitzugeben, um die Anfrageverzögerung zu reduzieren.

Anfragebeispiel für Token-Authentifizierung

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

Anfragebeispiel für signature-Authentifizierung

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
Wichtig
  • Verwenden Sie unbedingt Client-end-URL als recognition-Eingang. https verwendet Port 8443.
  • Setzen Sie den http header Connection: Keep-Alive, um den Aufwand wiederholter Verbindungen zu optimieren.

Rückgabefelder

Field Description
statusCode Status code 0 bedeutet korrekte Authentifizierung. Weitere Informationen finden Sie unter status code
result Fehlermeldung oder Informationen zum target image
timestamp Serverzeit bei Rückgabe der response. Verwendet Unix timestamp-Format in Millisekunden
result.targetId Eindeutige ID des target image
result.trackingImage Base64 encoding-String des tracking image
result.name Target-Name
result.size Breite des recognition-Bildes (Einheit cm). Die Höhe des recognition-Bildes wird vom System anhand des hochgeladenen Bildes automatisch berechnet. Die Größe des recognition-Bildes entspricht der Größe des überlagerten virtuellen Inhalts
result.meta Base64-codierte Zusatzinformationen, zum Beispiel der String, der nach base64-Codierung eines json string entsteht
result.type Fest ImageTarget
result.active "1" aktiviert, "0" deaktiviert

Wichtige Rückgabecodes

Response HTTPCODE Status Result
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" }

Fehlercodes

Siehe vollständige Liste der status codes und error codes

Anfragebeispiel

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"
}

Antwortbeispiel

  • Wenn recognition einen Treffer erzielt, sieht die Rückgabestruktur wie folgt aus:

    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
    }
  • Wenn es kein passendes target image gibt, lautet das Rückgabebeispiel:

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