{"info":{"_postman_id":"d3c4c7e8-8c45-6dfd-a96f-01e38b04fd53","name":"Location Clustering","description":"

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)

\n\n

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)

\n\n

Any response has the format in JSON:\n

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

\n\n

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.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introduction","slug":"introduction"},{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"Error Codes","slug":"error-codes"},{"content":"Rate limit","slug":"rate-limit"}],"owner":"2072562","collectionId":"d3c4c7e8-8c45-6dfd-a96f-01e38b04fd53","publishedId":"7Lhjkb1","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2017-12-16T12:23:03.000Z"},"item":[{"name":"Add Client","id":"c46646c3-8c86-1c85-fbba-4c826fdd952a","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\":\"My name\",\r\n \"tradeName\":\"My commercial name\",\r\n \"email\":\"myemail@mail.com\",\r\n \"telephone1\":\"telephone\",\r\n \"contactName\":\"name\",\r\n \"contactSurname\":\"surname\",\r\n \"contactPosition\":\"position\",\r\n \"contactEmail\":\"contactmail@mail.com\",\r\n \"contactTelephone1\":\"telephone\",\r\n \"contactTelephone2\":\"telephone\",\r\n \"countryCode\":\"en\",\r\n \"defaultLocale\":\"en\",\r\n \"details\":\"\",\r\n \"url\":\"http://www.javocsoft.es\"\r\n}"},"url":"http://api.cl.javocsoft.es/ws/api/lclustering/v1/client/add","description":"

This request allows to sign up into Geofencing API.

\n","urlObject":{"protocol":"http","path":["ws","api","lclustering","v1","client","add"],"host":["api","cl","javocsoft","es"],"query":[],"variable":[]}},"response":[],"_postman_id":"c46646c3-8c86-1c85-fbba-4c826fdd952a"},{"name":"Activate Client HTML","id":"0d86f225-3347-857e-fc50-aec8747f5f4d","request":{"method":"GET","header":[{"key":"Content-Type","value":"text/html"}],"body":{"mode":"raw","raw":"{\r\n \"name\":\"Javier Gonzalez Serrano\",\r\n \"tradeName\":\"JavocSoft S.L\",\r\n \"email\":\"javocsoft@gmail.com\",\r\n \"telephone1\":\"934203479\",\r\n \"contactName\":\"Javier\",\r\n \"contactSurname\":\"Gonzalez Serrano\",\r\n \"contactPosition\":\"CEO\",\r\n \"contactEmail\":\"javiergs5676@gmail.com\",\r\n \"contactTelephone1\":\"657779257\",\r\n \"contactTelephone2\":\"\",\r\n \"countryCode\":\"es\",\r\n \"defaultLocale\":\"es\",\r\n \"details\":\"\",\r\n \"url\":\"http://www.javocsoft.es\"\r\n}"},"url":"http://api.cl.javocsoft.es/ws/api/lclustering/v1/client/activate/","description":"

This request allows to ACTIVATE a recently added client given its activation code.

\n","urlObject":{"protocol":"http","path":["ws","api","lclustering","v1","client","activate",""],"host":["api","cl","javocsoft","es"],"query":[],"variable":[]}},"response":[],"_postman_id":"0d86f225-3347-857e-fc50-aec8747f5f4d"},{"name":"Get Clusters","id":"3f4e19c7-601c-f564-ad03-1fb586b72c08","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"http://api.cl.javocsoft.es/ws/api/lclustering/v1//clusters/list?lat=&lng=&locale=&maxgf=&radius=&pixelDistanceMax=&zoomLevel=&clusterMinSize=&clusterReturnMarkers=","description":"

This request allows to get the clusters for a given client. Parameters allow to set the default language, the max number of clusters to be returned and also de radius of the clustering from the location.

\n","urlObject":{"protocol":"http","path":["ws","api","lclustering","v1","","clusters","list"],"host":["api","cl","javocsoft","es"],"query":[{"description":{"content":"

Required. The latitude of the location

\n","type":"text/plain"},"key":"lat","value":""},{"description":{"content":"

Required. The longitude of the location

\n","type":"text/plain"},"key":"lng","value":""},{"description":{"content":"

Optional. The language to use in any returned text. Default is \"en\".

\n","type":"text/plain"},"key":"locale","value":""},{"description":{"content":"

Optional. The max number of clusters to return. Default value is 20.

\n","type":"text/plain"},"key":"maxgf","value":""},{"description":{"content":"

Optional. The radius of the request to look POIs / Stores in from the location. Default is 1000 meters.

\n","type":"text/plain"},"key":"radius","value":""},{"description":{"content":"

Optional. A way to customize how points are clustered. Default is 40.

\n","type":"text/plain"},"key":"pixelDistanceMax","value":""},{"description":{"content":"

Optional. The initial Maps Zoom, bigger is further. Default is 12.

\n","type":"text/plain"},"key":"zoomLevel","value":""},{"description":{"content":"

Optional. The minimum locations of a cluster to become a cluster. Default is 8.

\n","type":"text/plain"},"key":"clusterMinSize","value":""},{"description":{"content":"

Optional. Set to true to get also the cluster locations. Default is false.

\n","type":"text/plain"},"key":"clusterReturnMarkers","value":""}],"variable":[]}},"response":[],"_postman_id":"3f4e19c7-601c-f564-ad03-1fb586b72c08"},{"name":"Get Clusters HTML","id":"f53ccff7-ccf7-4198-d1bd-fd09af56526b","request":{"method":"GET","header":[{"key":"Content-Type","value":"text/html"}],"body":{"mode":"formdata","formdata":[]},"url":"http://api.cl.javocsoft.es/ws/api/lclustering/v1//clusters/list/html?lat=&lng=&locale=&maxgf=&radius=&pixelDistanceMax=&zoomLevel=&clusterMinSize=&clusterReturnMarkers=&showGlobalCircle=&mapsApiKey=","description":"

\n","urlObject":{"protocol":"http","path":["ws","api","lclustering","v1","","clusters","list","html"],"host":["api","cl","javocsoft","es"],"query":[{"description":{"content":"

Required. The latitude of the location.

\n","type":"text/plain"},"key":"lat","value":""},{"description":{"content":"

Required. The longitude of the location.