Grupos
El endpoint de grupo le permite devolver una lista de sus grupos junto con el ID de grupo, el nombre y el tipo de grupo.
GET client-api/v1/groups
Solicitud
No hay parámetros adicionales.
Respuesta
Esquema
Root Array.
Key | Type | Description |
|
| El ID del grupo de visitantes. |
|
| El nombre del grupo de visitantes. |
|
| El tipo de grupo de visitantes. |
Ejemplo
[
{
"id": 1,
"name": "Visitors",
"type": "non-returning"
},
{
"id": 2,
"name": "Employees",
"type": "returning"
},
{
"id": 3,
"name": "Deliveries",
"type": "delivery"
}
]
Errores
No hay parámetros para este recurso, por lo que los errores se limitan a errores internos del servidor o errores no encontrados (404).
Grupos / Miembros
El endpoint de miembros de grupo le permite obtener una lista de los visitantes que regresan a un grupo específico. Los datos están paginados para un máximo de 200 miembros por página. Cada miembro describe información clave como campos personales, permisos, últimas entradas y salidas y más.
Para localizar el identificador de grupo, vaya a https://my.signinapp.com/manage y haga clic en el grupo para el que desea solicitar datos. El identificador del grupo aparecerá en la URL después de /group.
GET client-api/v1/groups/<group_id>/members
Solicitud
No hay parámetros adicionales.
Respuesta
La respuesta devuelta desde el endpoint de miembros de grupo está paginada. Utilice links.next para solicitar páginas posteriores de datos. En la última página, links.next tendrá un valor null.
Esquema
Root Object
Key | Type | Description |
|
| Valores clave de enlaces a otros resultados paginados del historial para esta solicitud. |
|
| Información sobre el conjunto de resultados. |
|
| Una lista de recursos de visitantes que regresan . |
Links Object Enlaces de paginación.
Key | Tipo | Descripción |
|
| URL de la primera página. |
|
| URL de la última página. |
|
| URL de la página anterior. |
|
| URL de la página siguiente. |
Meta Object
Key | Tipo | Descripción |
|
| El número de la página actual solicitada. |
|
| Desde la posición de registro. |
|
| URL solicitada. |
|
| Número de registros devueltos por página. |
|
| Hasta la posición del registro. |
Ejemplo
{
"links": {
"prev": null,
},
"meta": {
"current_page": 1,
"from": 1,
"per_page": 200,
"to": 200
},
"data": [
{
"id": 456,
"group_id": 123,
"site_id": null,
"qr_code": null,
"personal_fields": {},
"photo_url": "https://cdn.host.net/photos/n23KjhFh3j2h42399AL.jpg",
"last_in": "2020-02-06T17:46:00Z",
"last_out": "2020-02-07T09:13:25Z",
"status": "signed_out",
"permissions": {
"can_access_firelist": true,
"can_pre_reg": false,
"can_mobile_sign_in": true,
"can_view_sign_in_history": false,
"can_auto_sign_in": false,
"can_access_today": false
}
},
{
"..."
}
]
}
Errores
Más allá de los errores internos del servidor, los siguientes son tipos de respuesta probables.
Code | Description |
404 | El recurso especificado o uno de los parámetros no existe. Compruebe el id de grupo. |
422 | Se ha producido un error de validación. Es probable que el grupo seleccionado no sea del tipo returning. |
Sitios / Historial
El endpoint Historial le permite crear y automatizar sus propios informes para cada sitio. Especificando una fecha de inicio y de finalización con un intervalo máximo de 92 días, puede solicitar toda la actividad de entrada y salida de los visitantes estándar y de los visitantes frecuentes, como el personal. Si lo desea, puede filtrar estos resultados por grupo o por un miembro específico del grupo.
Para localizar el id de su sitio, vaya a https://my.signinapp.com/manage y haga clic en el sitio del que desea solicitar datos. El identificador del sitio aparecerá en la URL después de /site.
GET client-api/v1/sites/<site_id>/history
Solicitud
Key | Type | Required | Description |
date_from |
| true | La fecha desde la que buscar en el historial. El formato esperado es ISO-8601 |
date_to |
| true | Fecha hasta la que se buscará en el historial. El formato esperado es ISO-8601 |
group_id |
| false | El ID de un grupo de visitantes por el que filtrar el historial. |
returning_visitor_id |
| false | El ID de un visitante que regresa para filtrar el historial. |
Rango de fechas
El intervalo de fechas para el endpoint del historial hasta un máximo de 92 días.
Respuesta
La respuesta devuelta desde el endpoint del historial está paginada. Utilice links.next para solicitar las siguientes páginas de datos. En la última página, links.next tendrá un valor null.
Esquema
Root Object
Key | Type | Description |
|
| Valores clave de enlaces a otros resultados paginados del historial para esta consulta. |
|
| Información sobre el conjunto de resultados. |
|
| Una lista de [recursos del visitante] (/client-api/resources.md#visitor-resource). |
Enlaces Object Enlaces de paginación.
Key | Type | Description |
|
| URL de la primera página. |
|
| URL de la última página. No se utiliza y siempre será nulo. |
|
| URL de la página anterior. |
|
| URL de la página siguiente. |
Meta Object
Key | Type | Description |
|
| El número de la página actual solicitada. |
|
| Desde la posición de registro. |
|
| URL de la solicitud. |
|
| Número de registros devueltos por página. |
|
| Hasta la posición del registro. |
Ejemplo
{
"links": {
"last": null,
"prev": null,
},
"meta": {
"current_page": 1,
"from": 1,
"per_page": 30,
"to": 30
},
"data": [
{
"id": 456,
"returning_visitor_id": null,
"name": "Jane Doe",
"photo_url": null,
"badge_url": null,
"status": "signed_out",
"in_datetime": "2020-02-06T17:46:00Z",
"out_datetime": "2020-02-07T09:13:25Z",
"expected_datetime": null,
"additional_fields": {
"Visiting": "John Doe"
},
"personal_fields": []
},
{
"..."
}
]
}
Errores
Más allá de los errores internos del servidor, los siguientes son tipos de respuesta probables.
Code | Description |
404 | El recurso especificado o uno de los parámetros no existe. |
422 | Se ha producido un error de validación. Compruebe el valor introducido con la descripción de los parámetros de la solicitud. |
Sitios / Hoy
El endpoint Hoy le permite crear una vista en vivo de quién ha registrado entrada en su sitio. También devuelve una lista de invitados pre-registrados. La actividad de registro se agrupa, lo que facilita la creación de un panel para un grupo específico de visitantes, mostrar los próximos visitantes o destacar el registro más reciente en su sistema de señalización digital.
Para localizar el identificador de su sitio, vaya a https://my.signinapp.com/manage y haga clic en el sitio para el que desea solicitar datos. El identificador del sitio aparecerá en la URL después de /site.
GET client-api/v1/sites/<site_id>/today
Solicitud
Sin parámetros obligatorios ni opcionales.
Respuesta
Esquema
Root Array. Una lista de recursos de grupo.
[
{"..."},
{"..."}
]
Ejemplo
[{
"id": 456,
"name": "Visitors",
"type": "non-returning",
"visitors": []
},
{
"id": 654,
"name": "Staff",
"type": "returning",
"visitors": [
{
"id": 789,
"returning_visitor_id": 987,
"name": "John Smith",
"photo_url": "https://example.com/path/to/image",
"badge_url": null,
"status": "signed_in",
"in_datetime": "2019-12-12T12:12:12Z",
"out_datetime": null,
"expected_datetime": null,
"additional_fields": {
"Company": "Acme Co",
"Invite Email": "[email protected]"
},
"personal_fields": {
"name": "John Smith",
"email": "[email protected]",
"mobile": "",
"role": "Manager"
}
}
]
}]
Errores
No hay parámetros para este recurso, por lo que los errores se limitan a errores internos del servidor o errores no encontrados (404).
Spaces / Reservas
El endpoint de Spaces le permite crear sus propios informes para las reservas de Spaces. Especificando una fecha de inicio y una fecha de finalización con no más de 60 días de diferencia, puede solicitar todas las reservas durante ese periodo. Estos resultados pueden filtrarse por espacio, zona y categoría.
Para localizar el identificador del sitio, vaya a https://my.signinapp.com/manage y haga clic en el sitio para el que desea solicitar datos. El id del sitio será visible en la URL después de /site.
GET client-api/v1/spaces/<site_id>/bookings
Solicitud
Key | Type | Required | Description |
filter[date_between] |
| true | El intervalo de fechas entre el que se buscarán las reservas. El formato esperado es ISO-8601 |
filter[site_id] |
| true | El ID del sitio por el que filtrar el historial. |
filter[returning_visitor_id] |
| false | El ID de un visitante que vuelve para filtrar el historial. |
filter[space_id] |
| false | El ID de cadena de un espacio específico |
filter[zone_id] |
| false | El ID de cadena de una zona específica |
Filtro
Con el endpoint de reserva de Spaces es necesario utilizar la opción Filtro para establecer el marco temporal de la llamada a la API o para filtrar con parámetros adicionales. El formato es ?filter[] para el primer filtro y &filter[] para los filtros adicionales. La key de solicitud anterior va dentro de los corchetes. Por ejemplo:
?filter[date_between]=2023-05-01,2023-05-31&filter[returning_visitor_id]=6462197
Esta solicitud devolvería las reservas desde el 1 de mayo de 2023 hasta el 31 de mayo de 2023 para el visitante con el ID 6462197.
Localización de ID de espacio y zona
Si desea incluir los ID de espacio o zona en su llamada a la API, puede encontrarlos en el portal de aplicaciones de acceso. Haga clic en la pestaña Spaces y seleccione el espacio o la zona de la lista de la izquierda de la pantalla. El ID de Espacios o Zona es el valor alfanumérico que aparece al final de la URL.
Respuesta
La respuesta devuelta desde el endpoint espacios está paginada. Utilice links.next para solicitar páginas de datos posteriores. En la última página, links.next tendrá un valor nulo.
Esquema
Root Object
Key | Type | Description |
|
| Valores clave de enlaces a otros resultados paginados del historial para esta consulta. |
|
| Información sobre el conjunto de resultados. |
|
| Una lista de [recursos del visitante] (/client-api/resources.md#visitor-resource). |
Enlaces Objeto Enlaces de paginación.
Key | Type | Description |
|
| URL de la primera página. |
|
| URL de la última página. No se utiliza y siempre será nulo. |
|
| URL de la página anterior. |
|
| URL de la página siguiente. |
Meta Object
Key | Type | Description |
|
| El número de la página actual solicitada. |
|
| Desde la posición de registro. |
|
| URL de la solicitud. |
|
| Número de registros devueltos por página. |
|
| Hasta la posición del registro. |
Ejemplo
{
"data": [
{
"id": 1201999,
"site_space_id": 23156,
"returning_visitor": {
"id": 2935520,
"name": "Joe Bloggs",
"photo_url": null
},
"space": {
"id": "MTHUFKkBMj",
"name": "Desk 1",
"photo": null,
"category": "desk",
"description": null,
"capacity": 1,
"zones": [
{
"name": "Floor 1"
}
]
},
"start_date": "2022-11-21T17:00:00Z",
"end_date": "2022-11-21T18:00:00Z",
"occupancy": 1,
"note": null
}
Errores
Code | Description |
404 | El recurso especificado o uno de los parámetros no existe. Compruebe el id de grupo. |
422 | Se ha producido un error de validación. Es probable que el grupo seleccionado no sea del tipo que regresa. |