Mencari target recognition | POST /v2/search

Mencari image target, yaitu interface recognition untuk mencari gambar dengan gambar.

Action

POST /v2/search

Autentikasi

Diperlukan

Http Header

Content-Type : multipart/form-data

Authorization (hanya saat menggunakan autentikasi API Key Token)

Parameter request

Field	Type	Required	Description
image	Multipart	Yes	String base64 encoding dari konten gambar, mendukung gambar format JPG dan PNG.
notracking	String	No	"false" berarti mengembalikan trackingImage. "true" berarti hanya mengembalikan properti targetId yang terdeteksi dan tidak mengembalikan tracking image. Untuk WebAR, disarankan membawanya secara default untuk mengurangi latensi request.

Contoh request autentikasi 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

Contoh request autentikasi signature

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

Penting

Pastikan menggunakan Client-end-URL sebagai entry point recognition. https menggunakan port 8443.
Set http header Connection: Keep-Alive untuk mengoptimalkan overhead koneksi berulang.

Field response

Field	Description
statusCode	Status code 0 berarti autentikasi benar. Untuk informasi lebih lanjut, lihat status code
result	Pesan error, atau informasi target image
timestamp	Waktu server saat response dikembalikan. Menggunakan format Unix timestamp dalam milidetik
result.targetId	ID unik target image
result.trackingImage	String base64 encoding dari tracking image
result.name	Nama target
result.size	Lebar gambar recognition (unit cm). Tinggi gambar recognition akan dihitung otomatis oleh sistem berdasarkan gambar yang Anda unggah. Ukuran gambar recognition sesuai dengan ukuran konten virtual yang ditumpangkan
result.meta	Informasi tambahan yang dienkode base64, misalnya string yang dihasilkan setelah string json dienkode base64
result.type	Tetap ImageTarget
result.active	"1" aktif, "0" nonaktif

Kode return utama

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

Kode error

Lihat daftar lengkap status code dan error code

Contoh request

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

Contoh response

Jika recognition berhasil mengenai target, struktur return adalah sebagai berikut:


    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
    }

Jika tidak ada target image yang cocok, contoh return adalah sebagai berikut:


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

Table of Contents