Si desea utilizar la nueva API local de BioStar 2 como una API RESTful para su propia personalización u otros fines, simplemente puede consultar este artículo. Este artículo lo ayudará a agregar o eliminar usuarios del grupo de acceso en su BioStar 2 mediante el uso de la nueva API local.


Asegúrese de echar un buen vistazo al código de ejemplo del programa C# creado para llamadas 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 que se usa para las llamadas a la API RESTful.


Para obtener más detalles sobre la API, consulte https://bs2api.biostar2.com/#intro 



Crear nuevo grupo de acceso


POST Crear nuevo AG

https://127.0.0.1/api/access_groups


Esta solicitud se utiliza para crear un nuevo grupo de acceso (AG)


Los parámetros son los siguientes:


ParámetroTipoRequeridoDescripción
nameStringYEl nombre de la AG. Debe ser único
descriptionStringNAG's description
usersNúmeroNLista de id de usuario(s) del AG
user_groupNúmeroNLista de ID de grupo(s) de usuarios del AG
access_levelsNúmeroNLista de identificación de nivel(es) de acceso del AG
floor_levelsNúmeroNLista de identificación de nivel(es) de piso del AG

El parámetro floor_levels aún no está disponible. Omita el parámetro o póngalo así > "floor_levels": ""

Para valores numéricos (como ID), el valor se puede poner en una cotización o no


Errores conocidos:


Poner "/" al final del punto final

el nombre es un parámetro requerido y único


Request Body

 {    "AccessGroup": {        "name": "access_group_test",        "description": ""        "users": [            {                "user_id": 1750            }        ],        "user_groups": [            {                "id": 10871            }        ],        "access_levels": [            {                "id": 53            }        ],        "floor_levels": [],    }
}
JavaScript



Actualizar Grupo de Acceso


PUT actualizar grupo de acceso

https://127.0.0.1/api/access_groups/:id


Este punto final se usa para reemplazar el grupo de acceso con valores de id {id}/:id con el especificado por los parámetros a continuación:

ParameterTypeRequiredDescription
nameStringYThe name of the AG. Must be unique
descriptionStringNAG's description
new_usersArrayNList of user(s) id to be added to AG
delete_usersArrayNList of user(s) id to be deleted from AG
user_groupNumberNList of user group(s) id of the AG
access_levelsNumberNList of access level(s) id of the AG
floor_levelsNumberNList of floor level(s) id of the AG

Errores conocidos:


Repetir el mismo valor en el parámetro con múltiples opciones



1. Adición de un usuario a un grupo de acceso existente

 {    "AccessGroup": {        "user_groups": [            {                "id": 10871,                "name": "User Group 1"            }        ],        "new_users": [            {                "user_id": 1753            },            {                "user_id": 1749            }        ]    }
}
JavaScript


2. Eliminación de un usuario en un grupo de acceso existente

 {    "AccessGroup": {        "user_groups": [            {                "id": 10871,                "name": "User Group 1"            }        ],        "delete_users": [            {                "user_id": 1753            },            {                "user_id": 1750            }        ]    }
}
JavaScript

3. Agregar y eliminar usuarios al mismo tiempo

 {    "AccessGroup": {        "user_groups": [            {                "id": 10871,                "name": "User Group 1"            }        ],        "new_users": [            {                "user_id": 1750            },            {                "user_id": 1753            }        ],        "delete_users": [            {                "user_id": 1749            }        ]    }
}
JavaScript


4. Adición/eliminación de un grupo de usuarios al grupo de acceso

In this example, "User Group 1" with ID 10871 is already assigned to the Access Group.
  • Cuando agrega/elimina un grupo de usuarios, eliminará cualquier dato anterior y agregará el que ingresó

    Ejemplo: si tiene un Grupo de usuarios 1 existente y, al actualizar, coloca solo el Grupo de usuarios 2 en el parámetro user_group, el Grupo de usuarios 1 se eliminará del Grupo de acceso y solo permanecerá el Grupo de usuarios 2.



    Si desea agregar más grupos de usuarios, deberá especificar los grupos de usuarios actuales. Si solo pones el añadido se eliminarán todos los datos anteriores.



    Para omitir la actualización de un registro, omita el parámetro. En el siguiente ejemplo, los usuarios no están actualizados.



    Ejemplo 1: agregar el grupo de usuarios 2 del grupo de acceso existente.

     {    "AccessGroup": {        "user_groups": [            {                "id": 10871,                "name": "User Group 1"            },            {                "id": 10872,                "name": "User Group 2"            }        ]    }
}
    JavaScript

    Ejemplo 2: Eliminación del Grupo de usuarios 2 del Grupo de acceso existente.

    {    "AccessGroup": {        "user_groups": [            {                "id": 10871,                "name": "User Group 1"            }        ]    }
}
    JavaScript

    Ejemplo 3: Eliminar el Grupo de usuarios 1 y agregar el Grupo de usuarios 2.

    {    "AccessGroup": {        "user_groups": [            {                "id": 10872,                "name": "User Group 2"            }        ]    }
}
    JavaScript