Pencarian dan identifikasi target| POST /v2/search

Mencari target gambar, antarmuka identifikasi gambar-dengan-gambar.

Action

POST /v2/search

Otentikasi

Dibutuhkan

Http header

Content-Type : multipart/form-data

Authorization (hanya saat menggunakan metode otentikasi API Key Token)

Parameter permintaan

Field	Type	Required	Deskripsi
image	Multipart	Ya	String pengkodean base64 dari konten gambar, mendukung format gambar JPG dan PNG.
notracking	String	Tidak	"false" berarti mengembalikan trackingImage gambar pelacakan. "true" berarti hanya mengembalikan properti targetId yang terdeteksi, tidak mengembalikan gambar pelacakan. WebAR secara default disarankan untuk menyertakan ini untuk mengurangi latensi permintaan.

Contoh permintaan otentikasi 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 permintaan otentikasi tanda tangan

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

• Harus menggunakan Client-end-URL sebagai pintu masuk identifikasi, https adalah port 8443
• Setel http header Connection: Keep-Alive untuk mengoptimalkan overhead koneksi berulang

Bidang pengembalian

Bidang	Deskripsi
statusCode	Kode status 0 menunjukkan otentikasi benar, lebih lanjut lihat Kode status
result	Pesan kesalahan, atau informasi gambar target
timestamp	Waktu sisi server saat respons dikembalikan. Menggunakan format stempel waktu Unix, dalam milidetik
result.targetId	ID unik gambar target
result.trackingImage	String pengkodean base64 dari gambar pelacakan
result.name	Nama target
result.size	Lebar gambar identifikasi (satuan cm). Tinggi gambar identifikasi akan dihitung secara otomatis oleh sistem berdasarkan gambar yang Anda unggah. Ukuran gambar identifikasi sesuai dengan ukuran konten virtual yang ditumpangkan
result.meta	Informasi tambahan yang dikodekan base64, misalnya string yang dihasilkan setelah mengkodekan string json dengan base64
result.type	Tetap ImageTarget
result.active	"1" diaktifkan, "0" dinonaktifkan

Kode pengembalian utama

Respons	HTTPCODE	Status	Hasil
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 kesalahan

Lihat Daftar lengkap kode status dan kesalahan

Contoh permintaan

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 pengembalian

• Jika berhasil diidentifikasi, struktur pengembalian seperti gambar:

    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 gambar target yang cocok, contoh pengembalian sebagai berikut:

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