Manual completo de las APIs de Horizoon para que puedas integrar y comunicar con otro software todas las funcionalidades.
1. Introducción API
Mediante la API de Horizoon podrás acceder a gran parte de las funcionalidades propias de Horizoon para integrar todo el CORE en otras plataformas o software. Si lo deseas, también podrás utilizarlo para integrar las funcionalidades de Horizoon en tus propias APPs.
2. Llamadas y respuestas de la API
Las llamadas a todas las API se harán mediante el envío de una petición POST a la siguiente dirección:
https://www.dominiodelainstalacion.com/rutadelainstalacion/horizoonAPIv2.php/main/idiomadelainstalacion
Así por ejemplo, para la instalación de horizoon llamada «help» ubicada en el domino «www.horizoon.com» e idioma español (código idioma: es) , se realizará la siguiente llamada:
https://www.horizoon.com/instalacion1/horizoonAPIv2.php/main/es
En esta petición se incluirá el envío de las variables POST que requiera cada método, así como unas variables obligatorias que deben enviarse siempre en toda petición a cualquier método de la API.
Las variables obligatorias son:
Nombre de la variable | obligatoria | descripción de la variable |
---|---|---|
TokenNS | SI | Valor alfanumérico que proporciona horizoon para cada instalación, y por lo tanto para cada API. Ejemplo: 5HGD562GHS8HS8 |
horizoonMTD | SI | Nombre del método (case sensitive). Por ejemplo: RegistrarLocalizacion |
TokenSessionAPI | SI | Valor alfanumérico de la sessión actual de las llamadas a la API. Este valor se obtiene al hacer login |
Como respuesta, la API devolverá siempre un JSON de resultado o un JSON de error. El JSON de resultado devuelto en cada método se explica más delante en cada uno de los métodos. El JSON de error vendrá siempre con el siguiente formato:
{
"Resultado": "0",
"ErrorCode": "Código del error",
"ErrorMensaje": "Texto con el error"
}
Cada método puede devolver códigos y mensajes de error distintos, todos ellos están definidos en la explicación de cada uno de los métodos. A pesar de ello, los siguientes códigos de error son comunes a todas las APIs:
código de error | texto de error |
---|---|
0001 | Llamada a método no tokenizada |
0002 | Llamada sin método |
0003 | Método no encontrado |
3. Petición de API personalizada
Las APIs de horizoon están diseñadas principalmente para la funcionalidad estándard de horizoon. Si tienes alguna necesidad específica que requiera la creación de una nueva API o deseas una librería de APIs personalizadas, puedes solicitar presupuesto AQUI.
4. Métodos API v2
A continuación se explican todos los métodos.
4.1. Método: RegistrarLocalizacion
Este método registrará las coordenadas de geolocalización de un usuario en la tabla localizaciones de la base de datos. Además es posible indicar si se trata de una simple geolocalización de coordenadas, o por el contrario corresponde a una ENTRADA o una SALIDA. También de forma opcional se puede vincular este registro de geolocalización con un elemento de mantenimiento.
variables petición método | obligatoria | VALOR/descripción de la variable |
---|---|---|
TokenNS | SI | Valor alfanumérico que proporciona horizoon para cada instalación, y por lo tanto para cada API. Ejemplo: 5HGD562GHS8HS8 |
horizoonMTD | SI | Nombre del método (case sensitive). Valor: RegistrarLocalizacion |
TokenSessionAPI | SI | Valor alfanumérico de la sessión actual de las llamadas a la API. Este valor se obtiene al hacer login |
Lat | SI | Coordenada de la Latitud de la posición que se desea registrar. Valor decimal, se guardaran un máximo de 8 decimales. |
Lon | SI | Coordenada de la Longitud de la posición que se desea registrar. Valor decimal, se guardaran un máximo de 8 decimales. |
Notas | SI | Un texto para dejar alguna nota sobre este registro de localización. Máximo de 200 caracteres. |
idTipoLocalizacion | SI | Tipo de la localización que se desea registrar: Valor entero numérico de entre los siguientes posibles: 1= ENTRADA 2= SALIDA 3= POSICIÓN |
idElementoMantenimiento | NO | id del elemento al cual se desea vincular el registro de localización que se envía. Valor entero numérico. |
TokenUserAPP | SI | Valor alfanumérico del TokenUserAPP del usuario del que se desea enviar el registro de localización. Cada usuario en horizoon tiene su propio TokenUserAPP , se trata de un id único para cada usuario que genera Horizoon. |
IdiomaAPP | SI | Código del idioma ISO 639-1 de la petición. Dicho idioma debe estar instalado en Horizoon y estar activado para la instalación. ejemplo para España: es |
RegistrationGcmToken | NO | Actualmente esta variable no se utiliza, puede omitirse o pasarse vacía. |
CreadoDesdeAPP | NO | Este parámetro sirve para informar del tipo de APP que ha enviado la petición: 1= Android 2= iOS |
Si se ha registrado correctamente la localización se devolverá el siguiente JSON de respuesta:
{"Resultado": "1"}
De lo contrario se devolverá un JSON de error con los siguientes posibles códigos:
{
"Resultado": "0",
"ErrorCode": "Código del error",
"ErrorMensaje": "Texto con el error"
}
código de error | texto de error |
---|---|
0001 | Error al localizar al usuario |
0002 | ERROR SQL |