Sign In App Documentation

Resumen

Esta API está diseñada para ayudarle a ampliar su experiencia Sign In App para incluir cuadros de mando personalizados, inteligencia empresarial e integración con aplicaciones de terceros.

Todos los puntos finales de la API están protegidos y las llamadas deben autenticarse utilizando el método descrito aquí.

Requisitos previos

• Una cuenta en my.signinapp.com (denominada Portal). Se pueden crear cuentas de prueba aquí.
• Un API de Cliente en el portal con una key y un secret utilizados para autenticarse con la API. Las instrucciones para configurar un Cliente API se pueden encontrar aquí.
• Lenguaje de programación con capacidad para realizar peticiones web (GET) y modificar cabeceras HTTP.

URI base

La URI base a llamar puede encontrarse como parte de los detalles al gestionar un Cliente API en el portal. Cada endpoint es específico del espacio Cliente en el que se crea el cliente. El host tendrá el aspecto de backend.region-x.signinapp.com. y el URI base será https://<base-url>/client-api/v1.

Datos de solicitud / respuesta

A menos que se especifique lo contrario, todos los endpoints reciben y devuelven datos JSON.

Content-Type: application/json

Problemas comunes y soluciones

Al realizar una petición, el endpoint devuelve el estado HTTP 302.

Esto se debe normalmente a que todos los endpoints requieren que las cabeceras Content-Type y Accept estén configuradas como application/json. Establecer estas cabeceras en todas las peticiones debería proporcionar el comportamiento esperado.

Recibir 404 en un endpoint que funcionaba con parámetros diferentes.

Esto puede deberse a que se han especificado parámetros de petición incorrectos. Al especificar IDs en recursos que no existen los endpoints devolverán un 404. Compruebe que los ID especificados son correctos.

Estructura y términos de la aplicación

A continuación se describen los distintos términos utilizados y sus relaciones dentro de la aplicación Sign In App.

• 'Client': Es su cuenta. Todos los usuarios del portal y los clientes de la API están vinculados a un cliente.
• 'Site'. Un sitio podría considerarse como la ubicación de una oficina. Muchos sitios pueden pertenecer a un cliente.
• 'Remote Site'. Se trata de un tipo especial de sitio que representa a los visitantes que se registran de forma remota. Un cliente tiene un sitio remoto.
• 'Device'. Un dispositivo es la tablet física que ejecuta Sign In App en la que los visitantes registran entrada. Cero o más dispositivos pueden estar conectados a un sitio.
• 'Mobile Device'. Un dispositivo móvil es el móvil de un visitante que regresa. Un dispositivo móvil está conectado a un visitante que regresa.
• 'Visitor Group'. Un grupo de visitantes puede ser un grupo de visitantes o de visitantes que regresan. Un cliente puede tener muchos grupos de visitantes.
• 'Visitor'. Un visitante es una persona que se registra en un grupo en la aplicación pero que puede que no vuelva. Puede haber muchos visitantes en un grupo.
• 'Returning Visitor'. Los visitantes que regresan son personas conocidas por el cliente que le visitan repetidamente. Puede haber muchos visitantes que regresan en un grupo.