Introducción
Si desea utilizar BioStar 2 API como una API RESTful para su propia personalización u otros fines, simplemente puede consultar este artículo. Este artículo lo guiará para registrar Suprema Mobile Access (Airfob Portal) para sus usuarios en BioStar 2 a través de Nueva API local.
Conceptos básicos y procedimientos
Para obtener información sobre Cómo usar Suprema Mobile Access, consulte el siguiente artículo:
[BioStar 2] Cómo usar Suprema Mobile Access
Para registrar el acceso móvil a su BioStar 2, debe conectar su portal Airfob a su BioStar 2. Consulte las pautas proporcionadas en el artículo anterior.
Una vez que su portal Airfob esté conectado a su BioStar 2, ahora puede registrar el acceso móvil a sus usuarios de BioStar 2.
*Por favor, tome nota
- La tarjeta de acceso móvil solo se puede usar con los dispositivos que están registrados en el registro de dispositivos de Mobile Crednetial.
- Cómo registrar dispositivos en Airfob Portal:
1. Configuración de > BioStar 2 > credencial móvil
2. Aplicación Airfob Pass. > Iniciar sesión en el portal Airfob > registrar dispositivos
Hay 4 pasos necesarios para registrar Mobile Access a sus usuarios:
- Comprueba si la tarjeta ya existe con el ID de tarjeta que deseas usar
- Crea una tarjeta con el ID de tarjeta que quieras usar
- Crear un acceso móvil
- Registre la tarjeta móvil para su usuario
Llamada y parámetros de API
- Paso 1. Comprueba si la tarjeta ya existe con el ID de tarjeta que deseas usar
[GET]: /api/v2/cards/registered/?card_id={card_id}
[Parámetros]
Nombre | Tipo | *M/O | Explicación | Valor |
|
|
|
|
|
* M – Obligatorio, O – Opcional
[Cuerpo de respuesta]: Si el ID de la tarjeta no está registrado
{ "Respuesta": { "código": "0" } } |
[Cuerpo de respuesta]: Si el ID de la tarjeta ya está en uso (registrado)
{ "Tarjeta": { "id": 19, "crdTypUid": 4, "crdCsn": "164438234751549" }, "Respuesta": { "código": "0" } } |
- Paso 2. Crea una tarjeta con el ID de tarjeta que quieras usar
[POST]: /api/cards
[Parámetros]
Nombre | Tipo | *M/O | Explicación | Valor |
Card_type.id | Cuerda | M | desc: ID de tipo de tarjeta (0:CSN, 1:WIEGAND, 2:SECURE, 3:ACCESS, 4:CSN_MOBILE, 5:WIEGAND_MOBILE, 6:QR /código de barras, 7:BioStar 2 QR) |
|
Card_type.nombre | Cuerda | M | Nombre del tipo de tarjeta |
|
Card_type.type | Cuerda | M | desc: Tipo de tarjeta (1:CSN, 2:SECURE, 3:ACCESS, 10:CSN_WIEGAND, 4:CSN_MOBILE, 5:WIEGAND_MOBILE, 6:QR /código de barras, 7:BioStar 2 QR) |
|
Card_type.mode | Cuerda | M |
| "M" |
Start_datetime | Cuerda | O | Start_datetime para la tarjeta móvil |
|
Expiry_datetime | Cuerda | O | Fecha y hora de caducidad de la tarjeta móvil |
|
Display_card_id | Cuerda | O | ID de visualización de la tarjeta |
|
Card_id | Cuerda | M | ID de la tarjeta |
|
isUserPhoto | Booleano | M | ¿Vas a usar User Photo para el acceso móvil? |
|
isDepartamento | Booleano | M | ¿Va a utilizar la información del departamento para el acceso móvil? |
|
isTitle | Booleano | M | ¿Vas a usar Información de título para el acceso móvil? |
|
* M – Obligatorio, O – Opcional
[Solicitar cuerpo]
{ "CardCollection": { "filas": [ { "isUserPhoto": false, "isDepartment": false, "isTitle": false, "card_type": { "id": "4", "name": "CSN Mobile", "tipo": "4", "modo": "M" }, "start_datetime": "2022-02-09T14:40:00.00Z", "expiry_datetime": "2022-02-10T14:40:00.00Z", "display_card_id": "164438521427749", "card_id": "164438521427749" } ] } } |
[Cuerpo de respuesta]
{ "CardCollection": { "total": "1", "filas": [ { "id": "19", "card_id": "164438521427749", "display_card_id": "164438521427749", "card_type": { "id": "4", "name": "CSN Mobile", "tipo": "4" }, "start_datetime": "2022-02-09T14:40:00.00Z", "expiry_datetime": "2022-02-10T14:40:00.00Z" } ] }, "Respuesta": { "código": "0", "link": "https://support.supremainc.com/en/support/home", "message": "Éxito" } } |
- Paso 3. Crear (registrar) un acceso móvil
[POST]: /api/v2/mobile
[Parámetros]
Nombre | Tipo | *M/O | Explicación | Valor |
Mobile.user_id | Cuerda | M | ID de usuario del usuario que utilizará este acceso móvil |
|
Mobile.name | Cuerda | M | Nombre de usuario del usuario |
|
Mobile.title | Cuerda | O | Título del Usuario | Nulo |
Mobile.department | Cuerda | O | Departamento del Usuario | Nulo |
Móvil.teléfono | Cuerda | O | Información telefónica del usuario | Nulo |
Mobile.email | Cuerda | O | Información de correo electrónico del Usuario | "abc@suprema.co.kr" |
Mobile.portraitData | Cuerda | O | Foto de perfil del usuario | Nulo |
Mobile.card_id | Cuerda | M | ID de tarjeta del acceso móvil | Ej) "164438234751549" |
Mobile.startDate | Int | M | Fecha de inicio del acceso móvil | 1644382320000 |
Mobile.endDate | Int | M | Fecha de finalización del acceso móvil | 1644468720000 |
* M – Obligatorio, O – Opcional
[Solicitar cuerpo]
{ "MobileCollection": { "móvil": { "user_id": [ "1" ], "nombre": [ "Javier Montoya Ortega" ], "título": [ nulo ], "departamento": [ nulo ], "teléfono": [ nulo ], "correo electrónico": [ "stars9408@naver.com" ], "portraitData": [ nulo ], "card_id": [ "1644382347515492" ], "startDate": [ 1644382320000 ], "endDate": [ 1644468720000 ] } } } |
[Cuerpo de respuesta]
{ "MobileCollection": { "listMobile": [ { "apisnddt": "2022-02-09T05:51:21.313Z", "userid": "1", "crdid": "164438234751549", "código de acceso": "", "portalrslt": "" } ] }, "Respuesta": { "código": "0" } } |
- Paso 4. Registre la tarjeta móvil para su usuario
[POST]: /api/users/{user_id}
[Parámetros] : parámetros básicos [POST] /api/User/{User_Id}.
* M – Obligatorio, O – Opcional
[Solicitar cuerpo]
{ "Usuario": { "tarjetas": [
{ "id": "19", "card_id": "164438234751549", "display_card_id": "164438234751549", "estado": "1", "is_blocked": "falso", "is_assigned": "verdadero", "card_type": { "id": "4", "name": "CSN Mobile", "tipo": "4" }, "mobile_card": "falso", "issue_count": "2", "card_slot": "1", "card_mask": "0", "wiegand_format_id": { "id": "0" }, "start_datetime": "2022-02-09T13:52:00.00Z", "expiry_datetime": "2022-02-10T13:52:00.00Z" } ] } } |
[Cuerpo de respuesta]
{ "Respuesta": { "código": "0", "link": "https://support.supremainc.com/en/support/home", "message": "Éxito" } } |