Search The Target | POST Client-end-URL/search/¶
Recognize the camera key frames
Authentication¶
Yes
Request parameters¶
field |
description |
required |
---|---|---|
image |
base64 encoded string of image content |
yes |
Response fields¶
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” } |
Notice: http port is 8080, your assigned Client-end-URL.
Example¶
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"
}
Response
Hit
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
}
No Matched
HTTP/1.1 404 NOT FOUND
Content-Type: application/json
{
"statusCode": 17,
"result": {
"message": "No result: there is no matching."
}
}