Table Of Contents

Previous topic

Get a target | GET /target/<target_id>

Next topic

Health check | GET /ping

Reco difficulty | POST /grade/detection/

Grade the target image according to how difficult it could be detected. The score is from 0 to 4. The higher the score is, the more difficult the target will be detected. -1 is errorcode for grading the image(image corrupted, or failed to grade whitepaper). You need to use this API before creating the target

Grade Description
0 or 1 Easy to detect
2 General
3 or 4 Difficult to detect

Action

POST /grade/detection/

Authentication

Yes

Request parameters

field description required
image base64 encoded string of image content yes

Response fields

field description
grade [-1, 0, 1, 2, 3, 4]. 0 and 1 are recommended for easy detection. -1 is error for grading.

Example

Request

POST /grade/detection/ 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

HTTP/1.1 200 OK
Content-Type: application/json
{
    "statusCode": 0,
    "result": {
        "grade": 1
    },
    "timestamp": 1514736000000
}