Ticketing API (PMS)
La API de tickets de Nuvify permite conectar servicios de terceros a su plataforma para automatizar la creación, modificación y eliminación de accesos a las redes que utilicen Nuvify.
Índice de contenidos
Actualización 1.0.1
Los sites que tengan la opción “Quick login” (https://cloud.nuvify.com/modules/quick-login) habilitada devuelven “Network” con la información de conexión a la red Wi-Fi de los clientes y un payload para iniciar sesión con el ticket generado. El protocolo es HTTP y la petición de login se realiza dentro de la red local.
Métodos
1. Crear
Ruta: /api/ticketing/v1/create
Método: POST
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
| Network | UID String. Ej. 30c9831e-b705-4795-9521-2b677b908367 | Identificador de la red Wi-Fi. |
| Code (opcional) | String [A-Z0-9] (Con prefijo. Ej. IPV0852) NOTA: Si no se especifica un código, este se generará de manera aleatoria. | Código para acceder a la red. |
| From | Datetime (2020-01-30 00:00:00) | Inicio del acceso. |
| To | Datetime (2020-12-30 00:00:00) | Fin del acceso. |
| Room | String | No de habitación. |
| Options | Array – speed: Up/Down, ej. 2m/2m, ej. 512k/1m – courtesyTime: Segundos, ej. 3600 – devicesLimit: Número, ej. 2 | Opciones – Velocidad – Tiempo extra al finalizar. – Límite de dispositivos. |
| Data (opcinal) | Array | Información extra. |
Respuestas
201 – CREATED
{
“message”: “Ticket created.”,
“ticket”: {
“code”: “IPV0852”,
“from”: “2019-12-31 00:00:00”,
“to”: “2020-03-30 00:00:00”,
“room”: “123-A”,
“options”: {
“speed”: “1m/1m”,
“courtesyTime”: 3600,
“devicesLimit”: 2
},
“data”: {
“name”: “Armando”,
“surname”: “Jaleo”,
“room”: “123-A”,
“pax”: 4
}
},
// Quick login habilitado:
“network”: {
“wifi”: {
// Tipos de autenticación:
// open, wpa2-psk, wpa2-enterprise, wep
“auth”: “open”,
“ssid”: “Hotel Nuvify”,
“password”: null
},
“login_url”: {
“sync”: “http://wifi.nuvify.es/login.html?autouser=IPV0852&autopass=9e41602ae47aa02e50d23e9c6a403841ba3d62f9”,
”async”: “http://wifi.nuvify.es/login
}
}
}422 – UNPROCESSABLE ENTITY
{
“message”: “The given data was invalid.”,
“errors”: {
“code”: [“Code is already registered.”]
}
}2. Cancelar
Ruta: /api/ticketing/v1/cancel
Método: PUT
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
| Code | String [A-Z0-9] (Con prefijo. Ej. IPV0852) | Código para acceder a la red. |
| Reason (opcional) | String. Max. 100. Opcional | Motivo de la cancelación. |
Respuestas
200 – CANCELLED
{
“message”: “Ticket cancelled.”,
“ticket”: {
“code”: “IPV0852”,
“from”: “2019-12-31 00:00:00”,
“to”: “2020-03-30 00:00:00”,
“room”: “123-A”,
“options”: {
“speed”: “1m/1m”,
“courtesyTime”: 3600,
“devicesLimit”: 2
},
“data”: {
“name”: “Armando”,
“surname”: “Jaleo”,
“room”: “123-A”,
“pax”: 4
}
},
// Quick login habilitado:
“network”: {
“wifi”: {
// Tipos de autenticación:
// open, wpa2-psk, wpa2-enterprise, wep
“auth”: “open”,
“ssid”: “Hotel Nuvify”,
“password”: null
},
“login_url”: {
“sync”: “http://wifi.nuvify.es/login.html?autouser=IPV0852&autopass=9e41602ae47aa02e50d23e9c6a403841ba3d62f9”,
”async”: “http://wifi.nuvify.es/login
}
}
}422 – UNPROCESSABLE ENTITY
{
“message”: “The given data was invalid.”,
“errors”: {
“code”: [“Code does not exist.”]
}
}3. Actualizar
Ruta: /api/ticketing/v1/update
Método: PUT
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
| Code | String [A-Z0-9] (Con prefijo. Ej. IPV0852) NOTA: El código no puede ser actualizado. | Código para acceder a la red. |
| To | Datetime (2020-12-30 00:00:00) | Fin del acceso. |
| Room | String | No de habitación. |
| Options | Array – speed: Up/Down, ej. 2m/2m, ej. 512k/1m – courtesyTime: Segundos, ej. 3600 – devicesLimit: Número, ej. 2 | Opciones – Velocidad – Tiempo extra al finalizar. – Límite de dispositivos. |
| Data (opcional) | Array | Información extra. |
Respuestas
200 – UPDATED
{
“message”: “Ticket updated.”,
“ticket”: {
“code”: “IPV0852”,
“from”: “2019-12-31 00:00:00”,
“to”: “2020-06-01 00:00:00”,
“room”: “321-B”,
“options”: {
“speed”: “2m/6m”,
“courtesyTime”: 7200,
“devicesLimit”: 4
},
“data”: {
“name”: “Armando”,
“surname”: “Jaleo”,
“room”: “321-B”,
“pax”: 4
}
},
// Quick login habilitado:
“network”: {
“wifi”: {
// Tipos de autenticación:
// open, wpa2-psk, wpa2-enterprise, wep
“auth”: “open”,
“ssid”: “Hotel Nuvify”,
“password”: null
},
“login_url”: {
“sync”: “http://wifi.nuvify.es/login.html?autouser=IPV0852&autopass=9e41602ae47aa02e50d23e9c6a403841ba3d62f9”,
”async”: “http://wifi.nuvify.es/login
}
}
}422 – UNPROCESSABLE ENTITY
{
“message”: “The given data was invalid.”,
“errors”: {
“code”: [“Code does not exist.”]
}
}
