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 le ayudará a crear grupos de usuarios para su BioStar 2 mediante el uso de la nueva API local.
Este artículo incluye una parte 'Crear grupos de usuarios' de una aplicación de ejemplo creada para aquellos que podrían necesitar usar la nueva API local de BioStar 2. Es una aplicación de consola de Visual C#.
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
- Cómo crear grupos de usuarios
Método | API | Qué hace | Parámetros |
EXPONER
| /api/user_groups | Crea grupos de usuarios en BioStar 2 | *Consulta a continuación |
[POST]: /api/Grupos de usuarios
[Parámetros]
Nombre | Tipo | *M/O | Explicación | Valor |
Parent_id.id.id | Int | M | Identificación de padre |
|
Profundidad | Int | O | Profundidad de Grupo de Usuarios |
|
Sync_device_groups | Arreglo | M |
|
|
Sync_devices | Arreglo | M |
|
|
Heredado | Booleano | O | Usar UserGroup heredado |
|
Mensaje de texto | Cuerda | O | Texto de grupo de usuarios |
|
Nombre | Cuerda | M | Nombre de grupo de usuario |
|
Identificación | Cuerda | O | UserGroup ID | Usar solo el número |
Estado | Cuerda | O | Estado de grupo de usuario | Ejemplo: abrir |
domId | Cuerda | O | UserGroup DomId | Ejemplo: _easyui_tree_283 |
disabledTreeNode | Booleano | O | Usar UserGroup DisabledTreeNode |
|
isTreeView | Booleano | O | Usar UserGroup IsTreeView |
|
isLeer | Booleano | O | Usar UserGroup isRead |
|
isWrite | Booleano | O | Usar UserGroup IsWrite |
|
Blanco | Array & Boolean | M |
| Ejemplo: true |
Comprobado | Booleano | M | Usar UserGroup Checked |
|
* M – Obligatorio, O – Opcional
Parte 2. Cuerpo de solicitud y modelo de respuesta
[Ejemplo de modelo de valor/parámetros]
{ "Grupo de usuarios": { "parent_id": { "id": 1 }, "profundidad": 1, "sync_device_groups": [ nulo ], "sync_devices": [ nulo ], "heredado": verdadero, "text": "Nuevo grupo de usuarios 1", "nombre": "Nuevo grupo de usuarios 1", "id": "1011", "estado": "abierto", "domId": "_easyui_tree_283", "disabledTreeNode": true, "isTreeView": verdadero, "isRead": verdadero, "isWrite": verdadero, "objetivo": {}, "marcado": falso } } |
[Modelo de respuesta]
{ "Grupo de usuarios": { "id": "1369", "nombre": "Nuevo grupo de usuarios 1" }, "Respuesta": { "código": "1003", "link": "https://support.supremainc.com/en/support/home", "message": "Éxito" }, "httpResponseStatus": 200 } |
[Respuesta: Fallo]
{ "Respuesta": { "código": "10", "link": "https://support.supremainc.com/en/support/home", "message": "Se requiere inicio de sesión". } } |
[Respuesta: Exitosa]
{ "Grupo de usuarios": { "id": "10000286", "name": "API New User Group" }, "Respuesta": { "código": "0", "link": "https://support.supremainc.com/en/support/home", "message": "Éxito" } } |
Parte 3. Ejemplo de creación de grupos de usuarios de la consola
[Código fuente del método Crear grupos de usuarios]
static async void CreateUserGroup() { Console.WriteLine("*****CreateUserGroup Task Started*****"); CookieContainer cookieContainer = nuevo CookieContainer();
Controlador HttpClientHandler = nuevo HttpClientHandler(); Controlador. CookieContainer = cookieContainer;
HttpClient httpClient = nuevo HttpClient(controlador);
Cliente HttpClient = nuevo HttpClient(controlador); httpClient.DefaultRequestHeaders.Add("bs-session-id", sessionID); cookieContainer.Add(nuevo URI(BioStarIP), nuevo Cookie("bs-session-id", sessionID)); string resourceAddress = BioStarIP + "/api/user_groups";
JavaScriptSerializer serializer = nuevo JavaScriptSerializer();
Console.WriteLine("Introduzca el NOMBRE del grupo de usuarios: "); nombre de cadena = Console.ReadLine(); Console.WriteLine("Escriba la DESCRIPCIÓN del grupo de usuarios: "); descripción de cadena = Console.ReadLine(); string payload = "{\"UserGroup\":{\"parent_id\":{\"id\":1},\"depth\":1,\"sync_device_groups\":[],\"sync_devices\":[],\"inherited\":true,\"text\":\"" + description + "\",\"name\":\"" + name + "\"}}"; Console.WriteLine(carga útil); StringContent sc = new StringContent(payload, Encoding.UTF8, "application/json"); HttpResponseMessage httpResponse = httpClient.PostAsync(resourceAddress, sc). Resultado;
if (httpResponse.IsSuccessStatusCode == true) { Console.WriteLine("Crear grupo de usuarios correctamente."); string httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); Console.WriteLine(httpResponseBody); } más { Console.WriteLine("Error al crear grupo de usuarios."); Console.WriteLine(httpResponse.ToString()); } } |
[Después de crear grupos de usuarios correctamente]
*Nombre de grupo de usuario de entrada
*Descripción del nombre del grupo de usuario de entrada
Parte 4. Crear grupos de usuarios 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]
*Solo los parámetros necesarios se escriben en el cuerpo de la solicitud
[Ejemplo de respuesta: cuerpo]
