Integracion API para luces y accesos
Doelectric
Integración de nuestro sistema mediante API


Para los equipos de control de luces, nuestro sistema consulta al HOST


ActivaLight

Comprueba si existe una reserva y activa o desactiva las luces de la pista en función del parámetro especificado.

Método HTTP: GET

Parámetros:
idresource: Indica la instalación el numero único de pista un entero del 1 al  9999

apiKey: Es la clave fija de autorización puede estar compuesta por un valor Alfanumérico de 1 a 15 caracteres máximo.
              Se usa como seguridad de que el cliente que hace la consulta esta autorizado.

[ IgnoreCalendar ] Valor booleano (true / false). Por defecto, true.
                                Le indicamos si deseamos que las luces estén encendidas durante la reserva o en función del un calendario
                                solar si existe. Si el calendario no existe nuestro sistema pasara el parámetro igualmente, el host lo debe
                                ignorar si no se usa. Este calendario seria util en pistas Exteriores donde ha luz solar.


Ejemplo petición al host sobre la pista numero 1 sin tener en cuenta el posible calendario:

http://nombredelclub.paginawebprincipal.com/api/ActivaLight?idresource=1&apikey=123456789AAA&IgnoreCalendar=true

Respuesta del HOST si no hay que activar la luz:

false

Respuesta del HOST si hay que activar la luz:

true



Ejemplo petición al host sobre la pista numero 1 teniendo en cuenta el posible calendario:

http://nombredelclub.paginawebprincipal.com/api/ActivaLight?idresource=1&apikey=123456789AAA&IgnoreCalendar=false

Respuesta del HOST si no hay que activar la luz:

false

Respuesta del HOST si hay que activar la luz:

true


Ejemplo petición al host sobre la pista numero 1 con parámetros erróneos:

http://nombredelclub.paginawebprincipal.com/api/ActivaLight?idresource=1&apikey=000000123456789AAA&IgnoreCalendar=false

Respuesta del HOST

false


http://nombredelclub.paginawebprincipal.com/api/ActivaLight?idresource=9999&apikey=123456789AAA&IgnoreCalendar=false

Respuesta del HOST

false


Cualquier parámetro no contemplado o una clave apikey incorrecta dará como respuesta  "false"

Esto es una recomendación:
Normalmente el host ante una consulta en la cual hay que activar la luz, debería de hacerlo por ejemplo 5 minutos antes de la reserva y 5 minutos después.

Por ejemplo si un cliente tiene una reserva de 10:00 a 11:00 Si consultamos:

A las 9:55 el host debería darnos "true" como respuesta.
Y si consultamos a las 11:05 debería darnos "true" como respuesta.
Y si consultamos a las 11:06 debería darnos "false" como respuesta.







Para los equipos de control de accesos, nuestro sistema consulta al HOST

AccesTerminal

Solicita acceso para tornos y puertas automáticas.
Si no se dispone de pulseras o tarjetas RF y el sistema funciona con lectores con teclado, es necesario que al hacer una reserva, el host
le envíe un mail al cliente con el pin aleatorio para acceder.
Ese PIN estará activo mientras el HOST considere oportuno permitiendo o no el acceso a las distintas salas.
El PIN será de caracteres numéricos.

Sugerencia:
El PIN podria ser el numero de telefono del cliente, con el cual se registro en la web. Ese numero es unico y de esta forma el cliente lo
recordara facilmente y no hay que enviar claves distintas en todas las reservas.


Método HTTP: GET

Parámetros:

apiKey: Es la clave fija de autorización puede estar compuesta por un valor Alfanumérico de 1 a 15 caracteres máximo.
              Se usa como seguridad de que el cliente que hace la consulta esta autorizado. 

cardCode El código de la tarjeta RF de acceso del cliente o el código PIN. De 1 a 25 caracteres Alfanuméricos.

idTerminal El identificadcor unico de acceso de la instalacion es numerico de 1 a 9999



Ejemplo petición al host sobre el acceso numero 1 y la clave 123456789A:

http://nombredelclub.paginawebprincipal.com/api/AccesTerminal?apikey=123456789A&cardCode=123456789&idTerminal=1

Respuesta del HOST si hay que ABRIR la puerta:

ACEPTADA

Respuesta del HOST si NO hay que ABRIR la puerta:

CANCELADA



Ejemplo petición al host sobre el acceso numero 1 y la clave 123456789A con parámetros erróneos

http://nombredelclub.paginawebprincipal.com/api/AccesTerminal?apikey=123456789A&cardCode=123456789777&idTerminal=9999

Respuesta del HOST NO hay que ABRIR la puerta:

CANCELADA


Cualquier parámetro no contemplado o una clave apikey incorrecta dará como respuesta "CANCELADA"

Esto es una recomendación:
Normalmente el host ante una consulta en la cual hay que abrir la puerta, debería de hacerlo por ejemplo 5 minutos antes de la reserva y 5 minutos después.

Por ejemplo si un cliente tiene una reserva de 10:00 a 11:00 Si consultamos:

A las 9:55 el host debería darnos "ACEPTADA" como respuesta.
Y si consultamos a las 11:05 debería darnos "ACEPTADA" como respuesta.
Y si consultamos a las 11:06 debería darnos "CANCELADA" como respuesta.






Para los equipos de control de accesos, nuestro sistema consulta al HOST

WebButton

Solicita estado de apertura o no de la puerta, para y desde la app del cliente o de la web.
Puede integrar en su web o app un botón de "Abrir puerta" cuando el cliente tenga una reserva activa, ese botón aparecerá y si el
cliente lo pulsa el acceso que tenga la reserva se abrirá.
Ese botón solo debería aparecer antes de la reserva (por ejemplo 10 minutos) durante la reserva y 10 minutos
después de finalizar la reserva. Estos tiempos son una sugerencia. Nuestro equipo revisa esta API cada 30 segundos.

Ejemplo de modo de funcionamiento del botón en la web o app:

1. Un cliente con reserva pulsa el botón "Abrir puerta" de la web.

2. Nuestro equipo consulta al host-> http://nombredelclub.paginawebprincipal.com/api/WebButton?apikey=123456789A&idTerminal=1

3. El host nos da: true y abrimos la puerta.

4. Nuestro equipo consulta al host -> http://nombredelclub.paginawebprincipal.com/api/WebButton?apikey=123456789A&idTerminal=1

5. El host nos da: false.

En resumen, el cliente pulsa el botón, la api toma el valor "true", una vez consultada por nuestro equipo, la api toma el valor
de  "false" de nuevo hasta que el cliente pulse otra vez el botón de "Abrir puerta" de la web o app.




Método HTTP: GET

Parámetros:

apiKey: Es la clave fija de autorización puede estar compuesta por un valor Alfanumérico de 1 a 15 caracteres máximo.
              Se usa como seguridad de que el cliente que hace la consulta esta autorizado. 

idTerminal El identificadcor unico de acceso de la instalacion es numerico de 1 a 9999



Ejemplo petición al host sobre el acceso numero 1 y la clave 123456789A:

http://nombredelclub.paginawebprincipal.com/api/WebButton?apikey=123456789A&idTerminal=1

Respuesta del HOST si hay que ABRIR la puerta:

true

Respuesta del HOST si NO hay que ABRIR la puerta:

false



Ejemplo petición al host sobre el acceso numero 1 y la clave 123456789 con parámetros erróneos

http://nombredelclub.paginawebprincipal.com/api/WebButton?apikey=123456789A&idTerminal=9999

Respuesta del HOST NO hay que ABRIR la puerta:

false


Cualquier parámetro no contemplado o una clave apikey incorrecta dará como respuesta "false"





















NOTA1:
Cuando cada pista o sala tiene su control de acceso no tiene utilidad ya que el idTerminal pasado por nuestro sistema sera el mismo que la sala o pista.

En instalaciones en las que solo exista accesos comunes y multiples pistas o salas en el mismo recinto es muy util ya que nuestro sistema sabra
que el cliente con clave por ejemplo: 123456789 tiene reserva en la pista por ejemplo 2. De esta forma en controles de acceso convinados de tipo 7 pistas y 7 accesos
se activara la luz correspondiente.

Si el Host por ejemplo nos da:

10,ACEPTADA

en este caso en la pista 10 se puede activar la luz

(El parametro "10" es el numero de pista o de acceso para el cual esa clave tiene validez) Leer NOTA1