Location Clustering

Introduction

This API allows to manage your POIs or stores in a easy way allowing doing geofencing in your web or application with just a few REST calls.

Overview

The API is a RestFUL webservice. The user must register and activate the account using the same API.

Authentication

The client authentication is done by a provided API token once the user is registered. Only registered and activated clients can use the API.

Error Codes

If the operation goes well, a 200 HTTP code is returned with the spected response. In case of an error, the code could be:

HTTP Bad Request (400)

HTTP Internal Server Error (500)

With one of the following codes:

1000 -> MISSING PARAMETER (A parameter is expected but it has not been provided in the request)

1001 -> INVALID PARAMETER VALUE (The parameter value is not expected)

1002 -> CLIENT ALREADY EXISTS (When registering a client but the client already exists)

1003 -> CLIENT ALREADY ACTIVATED (When activating a client but the client is already activated)

1004 -> INVALID FORMAT (When receiving a bad formatted JSON)

1005 -> INVALID CLIENT STATUS (The client status is not the expected one)

1006 -> MISSING FIELD (A field is expected but not received in the JSON)

2000 -> INVALID KEY (The client API key is not valid)

5000 -> INTERNAL SERVER ERROR (Any other error not due to user interaction)

Any response has the format in JSON:

{
    "result": {
        "errorCode": XXXX,
        "errorMessage": "Error message"
    },
    "success": false,
    "time": 1513428843938
}

The result value may contain an error, like the example or if there is no error, the expected result of the operation. To know when there have been an error or not you can check if the success parameter value is "true" or not. The time is the time in milliseconds of the response.

Rate limit

There is no rate limit in API requests that an user can send.