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 buscar grupos de usuarios en su BioStar 2 mediante el uso de la nueva API local.
Este artículo incluye una parte de 'Grupo de usuarios de búsqueda' 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 buscar grupos de usuarios
Método | API | Qué hace | Parámetros |
EXPONER | /api/v2/user_groups/search | Buscar todos los grupos de usuarios en BioStar 2 |
|
[POST] /api/v2/user_groups/search
[Parámetros]
Nombre | Tipo | *M/O | Explicación | Tipo de parámetro |
|
|
|
|
|
* M – Obligatorio, O – Opcional
Parte 2. Cuerpo de solicitud y modelo de respuesta
[Ejemplo de modelo de valor/parámetros]
|
[Modelo de respuesta]
{ "UserGroupCollection": { "total": 1, "filas": [ { "id": 1, "nombre": "Todos los usuarios", "profundidad": 0, "user_count": 1002 } ] }, "Respuesta": { "código": "0" }, "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]
{ "UserGroupCollection": { "total": 4, "filas": [ { "id": 1, "nombre": "Todos los usuarios", "profundidad": 0, "user_count": 4 }, { "id": 10000281, "nombre": "Nuevo Grupo 44", "profundidad": 1, "user_count": 2, "parent_id": { "id": 1 } }, { "id": 10000280, "nombre": "Nuevo grupo de usuarios", "profundidad": 1, "user_count": 0, "parent_id": { "id": 1 } }, { "id": 10000278, "nombre": "Nuevo grupo de usuarios 1", "profundidad": 1, "user_count": 0, "parent_id": { "id": 1 } } ] }, "Respuesta": { "código": "0" } } |
Parte 3. Ejemplo de grupos de usuarios de búsqueda de consola
[Código fuente del método de búsqueda de grupos de usuarios]
static async void SearchUserGroup() { Console.WriteLine("*****SearchUserGroup 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/v2/user_groups/search";
JavaScriptSerializer serializer = nuevo JavaScriptSerializer();
carga útil de cadena = "{}"; Console.WriteLine(carga útil); StringContent sc = new StringContent(payload, Encoding.UTF8, "application/json"); HttpResponseMessage httpResponse = httpClient.PostAsync(resourceAddress, sc). Resultado;
if (httpResponse.IsSuccessStatusCode == true) { string httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); Console.WriteLine(httpResponseBody); obj dinámico = JsonConvert.DeserializeObject(httpResponseBody); Console.WriteLine("**** LISTA DE GRUPOS DE USUARIOS: ****"); int UserTotal = obj. UserGroupCollection.total; for (int i = 0; i < UserTotal; i++) { Console.WriteLine(obj. UserGroupCollection.rows[i].id + " " + obj. UserGroupCollection.rows[i].name); } } más { Console.WriteLine("Error en el grupo de usuarios de búsqueda"); Console.WriteLine(httpResponse.ToString()); } } |
[Después de buscar grupos de usuarios correctamente]
Parte 4. Buscar 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]
*No se requiere nada para el cuerpo de solicitud
[Ejemplo de respuesta: cuerpo]
