Este artículo lo guiará a través de la inscripción de una tarjeta y la asignación a un usuario a través de la API de BioStar 2.
1) Enumerar todos los dispositivos agregados
2) Escanear tarjeta
3) Tarjeta de inscripción
4) Agregar credenciales de tarjeta a un usuario
PASO 1. Enumerar todos los dispositivos agregados
GET /api/devices
* Este paso se puede omitir si ya conoce el ID del dispositivo que va a utilizar para escanear la tarjeta. *
Esta API se utiliza para ver todos los dispositivos registrados en la base de datos de BioStar 2.
Obtenga el ID del dispositivo que desea usar para escanear la tarjeta que se agregará a las credenciales del usuario.
Ejemplo de solicitud de cartero:
Si tiene éxito, recibirá un código de respuesta 200 y un cuerpo de respuesta con una lista de todos los dispositivos.
Busque y guarde la "identificación" del dispositivo que desea usar para escanear la tarjeta en el siguiente paso. El valor "id" del dispositivo se utilizará como parte de la variable de ruta en la siguiente API.
El dispositivo que se va a utilizar debe tener un estado de conexión. Puede encontrar el 'estado' del dispositivo en el campo 'estado' en la respuesta :
Parámetro | Tipo | Descripción |
estado | Entero | Estado de conexión del dispositivo.0: Desconectado1: Conectado2: Error de sincronización |
Ejemplo de respuesta del cartero:
PASO 2. Tarjeta de escaneo
POST /api/devices/:id/scan_card
Esta API se utiliza para escanear la tarjeta con un dispositivo específico.
Variable de ruta :
El valor 'Id' se puede obtener en el PASO 1.
Parámetro | Descripción |
identificación | Id del dispositivo utilizado para el escaneo |
Ejemplo de solicitud de cartero:
Si tiene éxito, recibirá un código de respuesta 200 y un cuerpo de respuesta con la información de la tarjeta escaneada.
Busque y conserve los valores "card_type" y "card_id".
En el caso de una tarjeta wiegand, encuentre y conserve también el valor "wiegand_format_id".
Estos valores se utilizarán como parámetros para que la API inscriba la tarjeta en la base de datos de BioStar 2 en el siguiente paso.
Ejemplo de respuesta del cartero:
En este ejemplo específico, estoy leyendo una tarjeta wiegand para que también pueda ver el campo "wiegand_format_id" en la respuesta.
PASO 3. Tarjeta de inscripción
POST /api/cards
Esta API se utiliza para agregar una tarjeta a la base de datos de BioStar 2.
Parámetros del cuerpo:
Utilice los valores "card_type", "card_id" y "wiegand_format_id" (solo para la tarjeta de tipo wiegand) obtenidos en el paso 2.
Parámetro | Tipo | Obligatorio | Descripción |
card_type:id | Número | Y | Tipo de tarjeta ID de la tarjeta.0: Tarjeta CSN1: Tarjeta Wiegand2: Tarjeta de credencial segura (tarjeta inteligente)3: Acceso en tarjeta (tarjeta inteligente) |
card_type:tipo | Número | Y | Asignación de tipo del tipo de tarjeta. |
card_id | Número | Y | Valor de entrada mostrado/leído al escanear la tarjeta. |
wiegand_format_id:id | Número | Y | Obligatorio solo cuando se inscribe una tarjeta de tipo wiegand.0: Formato de 26 bits1: HID 37 bits-H103022: HID 37 bits-H103043: HID Corporate 1000 (35 bits)4: HID Corporate 1000 (48 bits)5~14: Formatos personalizados. |
Ejemplo de solicitud de cartero:
Si tiene éxito, recibirá un código de respuesta 200 y un cuerpo de respuesta con la información de la tarjeta inscrita.
Busque y conserve el valor "id" de la tarjeta recién inscrita para el siguiente paso. Este valor se usará como parámetro al agregar esta credencial de tarjeta a un usuario.
Ejemplo de respuesta del cartero:
También puede comprobar desde la interfaz de usuario web de BioStar que hay una tarjeta wiegand recién inscrita que aún no se ha asignado.
PASO 4. Agregar credenciales de tarjeta a un usuario
PUT /api/usuarios/:id
Variable de ruta :
Parámetro | Descripción |
identificación | ID de usuario del usuario al que desea agregar credenciales de tarjeta |
Parámetros del cuerpo:
Utilice el valor "id" obtenido del paso 3.
Parámetro | Tipo | Obligatorio | Descripción |
tarjetas:id | Número | Y | Identificación de la tarjeta |
Ejemplo de solicitud de cartero:
Si tienes éxito, recibirás un código de respuesta 200.
Ejemplo de respuesta del cartero:
También puede comprobar en la interfaz de usuario web de BioStar 2 que el usuario con el ID de usuario "4" ahora tiene una credencial de tarjeta de tipo wiegand.
