Geocercas
Métodos relacionados con las geocercas.
- Lista de geocercas - getGeofences
- Crear geocerca - createGeofence
- Actualizar geocerca - updateGeofence
- Eliminar geocerca - deleteGeofence
Lista de geocercas - getGeofences
POST https://api.service24gps.com/api/v1/getGeofences
Obtiene el listado de geocercas de tipo poligonal (dibujo), lineal (ruta) o circular.
Ver parámetros de solicitud:
| Parámetros | Descripción | Longitud | Ejemplo |
|---|---|---|---|
| apikey | Llave de autorización para uso de los Servicios Web. | 50 | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | Token devuelto por el método getToken. | 500 | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getGeofences' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"idCerca": 987984,
"idtipo_cerca": 2,
"tipo_cerca": "Circulo",
"nombre": "Geocerca 2",
"color": "#024769",
"puntos": [
{
"lat": 19.12084,
"lng": -98.24436
}
],
"radio": 160,
"limite_velocidad": 10,
"solo_mi_usuario": 0,
"visible": 0,
"umbral": {
"puntos_poligono": [],
"tolerancia": 0
},
"grupo": "Sin Asignar",
"compartida": 1
},
{
"idCerca": 46468,
"idtipo_cerca": 3,
"tipo_cerca": "Ruta",
"nombre": "Geocerca 3",
"color": "#FF0000",
"puntos": [
{
"lat": -15.350319,
"lng": -75.145134
},
{
"lat": -15.350459,
"lng": -75.145083
},
{
"lat": -15.35056,
"lng": -75.145035
},
{
"lat": -15.350728,
"lng": -75.144909
}
],
"radio": 0,
"limite_velocidad": 50,
"solo_mi_usuario": 0,
"visible": 0,
"umbral": {
"puntos_poligono": [
{
"lat": -15.350557,
"lng": -75.145837
},
{
"lat": -15.350758,
"lng": -75.14576
},
{
"lat": -15.35022,
"lng": -75.144379
},
{
"lat": -15.35008,
"lng": -75.14443
}
],
"tolerancia": 40
},
"grupo": "GRUPO TEST",
"compartida": 0
}
]
}Ver campos de respuesta:
| Campo |
Descripción |
Formato |
|---|---|---|
| idCerca |
Identificador único de la geocerca en el sistema. |
Entero |
| idtipo_cerca |
Indica el tipo de geocerca. 1 = Poligonal o dibujo 2 = Circular 3 = Lineal o ruta |
Entero |
| tipo_cerca |
Nombre del tipo de geocerca. |
Cadena de Texto |
| nombre |
Nombre con el que se identifica la geocerca dentro de la plataforma. |
Cadena de Texto |
|
color |
Color con el que se muestra e identifica la geocerca en la plataforma. |
Cadena de Texto (RGB hexadecimal) |
|
puntos |
Punto o puntos que conforman la geocerca. |
JSON |
|
radio |
Radio en metros que abarca la geocerca circular. |
Entero |
|
limite_velocidad |
Velocidad máxima (Km/h) permitida en la geocerca. |
Entero |
|
solo_mi_usuario |
Indica si la geocerca solo es visible para el usuario que la generó. 1 = Mi usuario 0 = Todos los usuarios |
Entero |
|
visible |
Indica si la geocerca se debe o no mostrar. 1 = Mostrar 0 = Ocultar |
Entero |
|
umbral |
Datos de la geocerca lineal o ruta, el cual contiene los puntos del polígono y la tolerancia. |
JSON |
|
grupo |
Nombre del grupo que pertenece la geocerca. |
Cadena de Texto |
|
compartida |
Indica si la geocerca es compartida. 1 = Compartida 0 = No compartida |
Entero |
Crear geocerca - createGeofence
POST https://api.service24gps.com/api/v1/createGeofence
Este método permite crear una geocerca de tipo: circular, poligonal o lineal.
Ver parámetros de solicitud:
| Parámetros | Descripción | Ejemplo |
|---|---|---|
| apikey | (Requerido) Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | (Requerido) Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| nombre |
(Requerido) Nombre con el que se identificará la geocerca dentro de la plataforma. |
GeoHome |
|
puntos |
(Requerido) Punto o puntos que conformarán la geocerca. |
[{"lat":-12.087574155453476,"lng":-77.08396062254906},{"lat":-12.087672508218587,"lng":-77.08401560783386},{"lat":-12.087707915205174,"lng":-77.08394654095173},{"lat":-12.087658083148632,"lng":-77.08388954401016},{"lat":-12.087618086359699,"lng":-77.08389893174171},{"lat":-12.08758989189834,"lng":-77.08392508327961},{"lat":-12.08757546682392,"lng":-77.08395726978779}] |
|
tipo_cerca |
(Requerido) Indica el tipo de geocerca a crear. 1 = Poligonal o dibujo 2 = Circular 3 = Lineal o ruta. |
1 |
|
color |
(Opcional) Color con el que se mostrará e identificará la geocerca en la plataforma, en formato RGB hexadecimal. |
#223344 |
|
radio |
(Opcional) Radio en metros que abarcará la geocerca circular. |
0 |
|
limite_velocidad |
(Opcional) Velocidad máxima (Km/h) permitida en la geocerca. |
50 |
|
solo_mi_usuario |
(Opcional) Indica si la geocerca solo es visible para el usuario que la generó. 1 = Mi usuario 0 = Todos los usuarios |
1 |
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/createGeofence' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'nombre="GeoHome"' \
--form 'puntos="[{\"lat\":-12.087574155453476,\"lng\":-77.08396062254906},{\"lat\":-12.087672508218587,\"lng\":-77.08401560783386},{\"lat\":-12.087707915205174,\"lng\":-77.08394654095173},{\"lat\":-12.087658083148632,\"lng\":-77.08388954401016},{\"lat\":-12.087618086359699,\"lng\":-77.08389893174171},{\"lat\":-12.08758989189834,\"lng\":-77.08392508327961},{\"lat\":-12.08757546682392,\"lng\":-77.08395726978779}]"' \
--form 'tipo_cerca="1"' \
--form 'color="#223344"' \
--form 'radio="0"' \
--form 'limite_velocidad="50"' \
--form 'solo_mi_usuario="1"'Respuesta de ejemplo:
{
"status": 200,
"data": ""
}Actualizar geocerca - updateGeofence
POST https://api.service24gps.com/api/v1/updateGeofence
Este método permite actualizar cualquier valor de una geocerca.
Ver parámetros de solicitud:
| Parámetros | Descripción | Ejemplo |
|---|---|---|
| apikey | (Requerido) Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | (Requerido) Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| idCerca |
(Requerido) Identificador único de la geocerca en el sistema. |
138225 |
| nombre |
Nombre con el que se identificará la geocerca dentro de la plataforma. |
GeoHome |
|
puntos |
Punto o puntos que conformarán la geocerca. |
[{"lat":-12.087574155453476,"lng":-77.08396062254906},{"lat":-12.087672508218587,"lng":-77.08401560783386},{"lat":-12.087707915205174,"lng":-77.08394654095173},{"lat":-12.087658083148632,"lng":-77.08388954401016},{"lat":-12.087618086359699,"lng":-77.08389893174171},{"lat":-12.08758989189834,"lng":-77.08392508327961},{"lat":-12.08757546682392,"lng":-77.08395726978779}] |
|
color |
Color con el que se mostrará e identificará la geocerca en la plataforma, en formato RGB hexadecimal. |
#223344 |
|
radio |
Radio en metros que abarcará la geocerca circular. |
0 |
|
limite_velocidad |
Velocidad máxima (Km/h) permitida en la geocerca. |
50 |
|
solo_mi_usuario |
Indica si la geocerca solo es visible para el usuario que la generó. 1 = Mi usuario 0 = Todos los usuarios |
0 |
|
visible |
Indica si la geocerca se debe o no mostrar. 1 = Mostrar 0 = Ocultar |
1 |
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/createGeofence' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idCerca="138225"' \
--form 'nombre="GeoHome"' \
--form 'puntos="[{\"lat\":-12.087574155453476,\"lng\":-77.08396062254906},{\"lat\":-12.087672508218587,\"lng\":-77.08401560783386},{\"lat\":-12.087707915205174,\"lng\":-77.08394654095173},{\"lat\":-12.087658083148632,\"lng\":-77.08388954401016},{\"lat\":-12.087618086359699,\"lng\":-77.08389893174171},{\"lat\":-12.08758989189834,\"lng\":-77.08392508327961},{\"lat\":-12.08757546682392,\"lng\":-77.08395726978779}]"' \
--form 'color="#223344"' \
--form 'radio="0"' \
--form 'limite_velocidad="50"' \
--form 'solo_mi_usuario="0"' \
--form 'visible="1"'Respuesta de ejemplo:
{
"status": 200,
"data": ""
}Respuesta de ejemplo:
{
"status": 200,
"data": ""
}Nota: Si la geocerca es de tipo compartida, no permitirá actualizar y mostrará un mensaje de error .
Respuesta de ejemplo:
{
"status": 200,
"data": {
"status": 30300,
"msg": "La geocerca es compartida, no se puede actualizar"
}
}Eliminar geocerca - deleteGeofence
POST https://api.service24gps.com/api/v1/deleteGeofence
Este método permite eliminar una geocerca especifica.
Ver parámetros de solicitud:
| Parámetros | Descripción | Ejemplo |
|---|---|---|
| apikey | (Requerido) Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
| token | (Requerido) Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
| idCerca |
(Requerido) Identificador único de la geocerca en el sistema. |
138225 |
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/deleteGeofence' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idCerca="138225"'Respuesta de ejemplo:
{
"status": 200,
"data": ""
}Nota: Si la geocerca es de tipo compartida, no permitirá eliminar y mostrará un mensaje de error .
Respuesta de ejemplo:
{
"status": 200,
"data": {
"status": 30300,
"msg": "La geocerca es compartida, no se puede eliminar"
}
}