Introducción
Si desea utilizar BioStar 2 New Local API como una API RESTful para su propia personalización u otros fines, simplemente puede consultar este artículo. Este artículo cubrirá el uso más básico de la aplicación de consola BioStar 2 New Local API by C#.
Esta es solo una aplicación de muestra hecha para aquellos que podrían necesitar usar la Nueva API Local de BioStar 2. Es una aplicación de consola de Visual C#.
Funciones
Este artículo cubrirá las siguientes funciones:
- Iniciar sesión
- Buscar usuarios
- Crear usuarios
- Crear usuarios con access group
- Recuperar datos de registro
- Recuperar datos de registro
A través de este artículo, no solo puede aprender a llamar a una función de API para recuperar los datos de registro dentro del período de tiempo desde y hasta el momento de su elección, sino también ordenarlos por la forma que desee. Por ejemplo, puede ordenar los datos de registro resultantes en el orden de tiempo, log_id y más. También puede ajustar la parte [condiciones] del cuerpo de su solicitud para ajustar el período de tiempo de su búsqueda del rango de ID de su búsqueda.
Asegúrese de echar un buen vistazo al código de ejemplo del programa de C# creado para llamadas a la API. Simplemente puede copiar y pegar el código fuente para usar la misma función en su propia integración.
También puede ver cómo llamar a las funciones de la API a través de Postman, que es un programa utilizado para las llamadas a la API RESTful.
Parte 1. Llamada a la API y parámetros
[POST]: /events/search
[Parámetros]
Nombre | Tipo | *M/O | Explicación |
... |
|
|
|
límite | entero | O | # de resultados que desea buscar |
Condiciones-valores | Matriz de cadenas | O | Dos matrices de fecha y hora para el período del evento, la hora de finalización debe ser mayor que la hora de inicio. *Fecha y hora en UTC en formato ISO-8601 (por ejemplo, 2015-06-10T02:14:05.268Z) |
Condiciones-operador | entero | O | desc: Operador de condición[ IGUAL : 0, NOT_EQUAL : 1, CONTIENE : 2, ENTRE : 3, COMO : 4, MAYOR : 5, MENOS : 6] |
|
|
| Puede recuperar los registros dentro de un cierto período de tiempo, id... etc. de su elección. |
Órdenes | Matriz de cadenas | O | Puede ordenar los resultados de la recuperación de registros por la columna de su elección (es decir, id, datetime... etc.) |
* M – Obligatorio, O – Opcional
Parte 2. Solicitar Cuerpo y Modelo de Respuesta
[Ejemplo de modelo de valor/parámetros]
1. Recupere los registros dentro del período de tiempo elegido y clasifíquelos por id |
{ "Consulta": { "límite": 500, "condiciones": [ { "columna": "fecha y hora", "operador": 3, "valores": [ "2021-07-01T15:00:00.000Z", "2021-08-10T14:59:59.000Z" ] } ], "pedidos": [ { "columna": "id", "descendente": falso } ] } } |
*Condiciones: "columna": "fecha y hora" indica que solo vería los registros del período de tiempo entre el primer valor (hora) y el segundo valor (tiempo).
*orders: "column" : "id" indica que desea ordenar los registros resultantes para que estén en el orden del valor de id de cada registro.
*Si lo cambia a "orders": "id" u otros valores, puede ordenar los registros por otros valores en consecuencia.
[Ejemplo de modelo de valor/parámetros]
2. Recupere los registros dentro de los 2 valores de identificación elegidos y clasifíquelos por id |
{ "Consulta": { "límite": 500, "condiciones": [ { "columna": "id", "operador": 3, "valores": [ "100", "100" ] } ], "pedidos": [ { "columna": "id", "descendente": falso } ] } } |
*Condiciones: "columna": "id" indica que solo vería los registros que se encuentran entre los 2 valores de id.
[Respuesta: Exitosa]
1. Resultado: recupere los registros dentro del período de tiempo elegido y clasifíquelo por id |
{ "EventCollection": { "filas": [ { "id": "1", "server_datetime": "2021-08-02T07:34:27.00Z", "datetime": "2021-08-01T22:34:26.00Z", "índice": "2", "user_group_id": { "id": "0", "nombre": "" }, "device_id": { "id": "939271697", "nombre": "BioStation A2 939271697 (192.168.13.132)" }, "event_type_id": { "código": "4095" }, "is_dst": "0", "zona horaria": { "mitad": "0", "hora": "9", ... |
2. Recupere los registros dentro de los 2 valores de identificación elegidos y clasifíquelos por id |
"EventCollection": { "filas": [ { "id": "100", "server_datetime": "2021-09-14T08:13:24.00Z", "datetime": "2021-09-13T23:13:23.00Z", "índice": "451", "user_id_name": "1(Administrador)", "user_id": { "user_id": "1", "nombre": "Administrador", "photo_exists": "falso" }, "user_group_id": { "id": "1", "nombre": "Todos los usuarios" }, "device_id": { "id": "538747164", "nombre": "BioLite N2 538747164 (192.168.13.141)" }, "event_type_id": { "código": "8704" }, "is_dst": "0", "zona horaria": { "mitad": "0", "hora": "9",... |
*Debe tener en cuenta que los registros pueden tener el mismo valor de id. Esto se debe a que los datos de registro se almacenan en diferentes tablas de datos que son para cada mes de cada año. Por ejemplo, puede haber 2 registros con el mismo valor de identificación pero de las diferentes tablas para agosto y septiembre de 2021.
Parte 4. Recuperar registros a través de Postman
[Ejemplo de solicitud: Encabezados]
*Debe usar el valor 'be-session-id' del encabezado de respuesta de la llamada a la API de inicio de sesión para autenticar el uso de la API para otras llamadas a la API.
[Ejemplo de solicitud]
[Ejemplo de respuesta: cuerpo]
