Get started with API

Targets in Cloud Database can be managed using either the WebUI Cloud Target Manager or the Web Services API.

EasyAR also provides Target Management Samples for developers by following languages:

The Access Information

Before you manage the target images, you have to create a new CRS App Instance.

step 1) Login account -> Developer Center -> CRS,

step 2) create new CRS Instance,

step 3) show the access information of your CRS App Instance:

  • API Key

  • API Secret

  • CRS AppId

  • Cloud URL

    • Server-end URL: For target management

    • Client-end URL: For client to recognize image

Web Service API

The parameters include:

  • Common signature parameters

    • timestamp

    • appId

    • apiKey

    • signature

  • API command parameters

    Common signature parameters are must, and API command’s parameters are defined by specific APIs.`

Refer Signing Example for more details about API authentication.

Example: Add new target

Here is a example of adding new target image, helping developers using the API

Please refer Best practice for adding new target to build your product release.

Request to add new target:

POST /targets/ HTTP/1.1
Host:
Date: Mon, 1 Jan 2018 00:00:00 GMT
Content-Type: application/json
{
    "image":"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgM...",
    "active":"1",
    "name":"easyar",
    "size":"5",
    "meta":"496fbbabc2b38ecs3460a...",
    "type":"ImageTarget",
    "timestamp": 1514736000000,
    "apiKey": "8b485c648c3056e79c2a85ee9b51f9dc",
    "appId": "C:CN1:f9f903c36da8bd64d71d491077bbaafd",
    "signature": "89985e2420899196db5bdf16b3c2ed0922c0c221"
}

Response:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "statusCode": 0,
    "result": {
        "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
}

Detailed description of response field, please refer the Chapter: Response field.

Next Reference: