Esta es una guía paso a paso para hacer uso de Webhook, para conectar datos directamente desde nuestra plataforma a otra plataforma o base de datos de terceros.
Para preguntas y ayuda contáctenos a: support@soconnect.io o +34 93 220 16 19
------------------------------------------------------------------------------------------------------
Webhook para inicios de sesión en eventos
Webhooks se puede utilizar para notificar a su propia aplicación sobre eventos en uno o más de sus lugares de SO Connect. Nuestros servidores harán un HTTP POST a un punto final que usted puede configurar que contendrá todos los datos relacionados con esa solicitud en el cuerpo como un objeto JSON. Las solicitudes vendrán en (casi) tiempo real y su aplicación puede procesarlas para adaptarlas a sus necesidades.
Actualmente, solo se admite un 'tipo de evento' como el tipo 'wifi_login'. Este evento se activa cada vez que un inicio de sesión wifi se lleva a cabo en un lugar. Tenga en cuenta que si un usuario inicia sesión varias veces, recibirá múltiples solicitudes para el mismo usuario.
El punto final debe devolver un estado de 200 para que nuestro sistema lo considere exitoso. Cuando una solicitud falla, se reintentará cada minuto durante un máximo de 10 minutos.
El rango de IP de donde provienen las solicitudes es 87.233.181.32/27, asegúrese de incluir esta lista en su servidor / firewall.
Configurando el webhook
Actualmente, los webhooks no se pueden configurar en el panel de control de SO Connect (aún).
Para habilitar un webhook para su aplicación, envíe la siguiente información a support@soconnect.io:
- URL de punto final: debe ser https
- Identificación de ubicación que debe estar vinculada a este punto final o si desea todas las ubicaciones, entonces la identificación de su cuenta será suficiente
- SO Connect luego habilitará el webhook y lo notificará una vez hecho.
Comprobando el webhook
Para las pruebas, tenemos algunas ubicaciones de prueba disponibles. Antes de ir a producción, podemos configurar su punto final allí. Recibirá un enlace de inicio de sesión de prueba para que pueda realizar pruebas con datos reales.
Descripción de la carga útil
- Evento:
- información sobre el evento en sí
marca de tiempo (entero): - la marca de tiempo de unix del evento en UTC
tipo (cadena 20): el tipo del evento (actualmente solo 'wifi_login')
- información sobre el evento en sí
- Ubicación: información sobre la ubicación donde se realizó el evento
- id (integer):la identificación de la ubicación en el panel de control de SO Connect
- nombre (string 255): el nombre de la ubicación como se establece en el Panel de control SO Connect
- external_reference (string 255): la referencia externa de la ubicación como se establece en el Panel de control SO Connect
- zona horaria (string 90 - Lista entera aquí: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones): la zona horaria de la ubicación como se establece en el Panel de control SO Connect. Esto se puede usar para convertir el evento a una hora local.
- latitude (decimal): la latitud de la ubicación (solo disponible cuando se usa hardware SO Connect)
- longitud (decimal): la longitud de la ubicación (solo disponible cuando se usa hardware SO Connect)
- Cuenta: información sobre el cliente al que pertenece la ubicación (la identificación y el nombre del lugar, el restaurante, el hotel, etc.)
- id (integer): Identificación del cliente en el Panel de control de SO Connect
- Nombre (string 255): nombre del cliente tal como está configurado en el panel de control SO Connect (es decir, Hotel Europa - Amsterdam)
- Usuario: información sobre el usuario / invitado wifi que se conectó al wifi en la ubicación (si está disponible)
- id (integer): id del usuario en el panel de SO Connect
- type (string 20): Tipo de usuario (facebook,twitter,linkedin,email,instagram,vk,voucher,login_skip)
- email (string 255):dirección de correo electrónico del usuario
- locale (string 5): lugar del usuario
- first_name (string 255)
- last_name (string 255)
- ciudad (string 255): ciudad actual del usuario proporcionada por Facebook
- género (string 1): M/F
- dia_de_nacimiento (string 12): en el formato aaaa-mm-dd
- Dispositivo: información del dispositivo que se utilizó para iniciar sesión
- user_agent (string 255): el agente de usuario del navegador
- mac_address (string 17): la dirección MAC wifi del dispositivo en el formato (11-22-33-AA-BB-CC)
Un ejemplo de carga útil:
{
"event": {
"timestamp": "1512548314",
"type": "wifi_login"
},
"location": {
"id": "12345",
"name": "SO Connect Headquarters",
"external_reference": "SCT-001",
"timezone": "Europe/Amsterdam",
"latitude": 52.3653963,
"longitude": 4.8790649
},
"account": {
"id": "123456",
"name": "SO Connect"
},
"user": {
"id": "13352700",
"type": "facebook",
"email": "test-user@soconnect.io",
"locale": "en_US",
"first_name": "Michael",
"last_name": "Jackson",
"city": "New York, United States",
"gender": "M",
"date_of_birth": "1991-03-07"
},
"device": {
"user_agent": "Mozilla/5.0 (Linux; Android 7.0; SM-G920F Build/NRD90M; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/62.0.3202.84 Mobile Safari/537.36",
"mac_address": "EC-1E-72-EA-AC-BF"
}
}
Encabezados de solicitud
Por defecto, el 'Tipo de evento' se envía en los encabezados al igual que el tipo de contenido, que está configurado como 'application / json' de forma predeterminada.
Event-Type: wifi_login
Content-Type: application/json
Los encabezados de las solicitudes personalizadas se pueden agregar a pedido.
------------------------------------------------------------------------------------------------------
Esto concluye la guía SO Connect Webhook.
Para preguntas y ayuda contáctenos a: support@soconnect.io o +34 93 220 16 19
Comentarios
0 comentarios
Inicie sesión para dejar un comentario.