Introducción
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 cubrirá el uso más básico de la aplicación de consola BioStar 2 New Local API by C#.
Esta es solo una aplicación de muestra hecha para aquellos que podrían necesitar usar la Nueva API Local de BioStar 2. Es una aplicación de consola de Visual C#.
Funciones
Este artículo cubrirá cómo registrar / anular el registro de la foto de perfil del usuario a través de la nueva API local.
A través de este artículo, puede aprender cómo llamar a una función API para registrar fotos de perfil a los usuarios en el servidor BioStar 2. Puede usar la función [PUT] /api/users/{id}, que es para actualizar cualquier información de un usuario, para registrar / anular el registro de fotos de perfil de usuario.
Para la mayor parte de la entrada relacionada con la imagen, debe convertir las imágenes al formato Base64. Por favor, tenga en cuenta que no debe tener "Base64 :" en su entrada para "foto".
Si tiene el valor "foto" como vacío, anulará el registro de la foto de perfil de usuario actual.
"foto": "/9j/4AAQSkZJRgABAQEASABI..." | Bien |
"foto": "Base64: /9j/4AAQSkZJRgABAQEASABI..." | Malo |
"foto": "" | Cancelar el registro de la foto de perfil |
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
[PUT]: /users/{id}
[Parámetros]
Grupo | Nombre | Tipo | *M/O | Explicación | Valor |
Usuario | foto | cuerda | O | Formato Base64 |
|
* M – Obligatorio, O – Opcional
Parte 2. Cuerpo de solicitud y modelo de respuesta
[Ejemplo de modelo de valor/parámetros]
{ "Usuario": { "foto": "/9j/4AAQSKZJRgABAQEA..." } } |
[Modelo de respuesta]
{ "DeviceResponse": { "filas": [ { "id": "541530887", "código": "65230" } ], "resultado": "falso" }, "Respuesta": { "código": "0", "link": "https://support.supremainc.com/en/support/home", "message": "Éxito" } } |
[Respuesta: Fallo]
{ "Respuesta": { "código": "65675", "link": "https://support.supremainc.com/en/support/home", "mensaje": "no definido" } } |
[Respuesta: Exitosa]
{ "Respuesta": { "código": "0", "link": "https://support.supremainc.com/en/support/home", "message": "Éxito" } } |
Parte 3. Ejemplo de registro de foto de perfil de usuario de consola
[Registrar el código fuente del método de foto de perfil de usuario]
El código fuente tiene una función para convertir la ruta de la imagen al formato 'Base64'. Solo tienes que introducir la {ruta\imagename.format} de la imagen para registrar la foto de perfil del usuario.
static async void RegisterProfilePhoto() { if (sessionID == null) { Console.WriteLine("¡Primero debe iniciar sesión!" ); volver; } 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(new Uri("https://127.0.0.1"), new Cookie("bs-session-id",sessionID)); ListUsers(); Console.WriteLine("Ingrese id de usuario para registrar la foto de perfil:"); string userid = Console.ReadLine(); string resourceAddress = "https://127.0.0.1/api/users/" + userid + ""; string photopath = ""; Archivo de cadena = ""; JavaScriptSerializer serializer = nuevo JavaScriptSerializer(); Console.WriteLine("Ingrese la ruta de la foto: * Deje VACÍO para anular el registro de la foto de perfil actual"); photopath = Console.ReadLine(); if(fotopath != "") { Byte[] bytes = File.ReadAllBytes(fotopath); archivo = Convert.ToBase64String(bytes); }
string payload2 = "{ \"Usuario\": { "; payload2 = payload2 + "\"foto\": \"" + archivo + "\"}}"; Console.WriteLine(payload2); StringContent sc = new StringContent(payload2, Encoding.UTF8, "application/json"); HttpResponseMessage httpResponse = await httpClient.PutAsync(resourceAddress, sc); HttpResponseMessage httpResponse = httpClient.PutAsync(resourceAddress, sc). Resultado;
if (httpResponse.IsSuccessStatusCode == true) { if (fotopath != "") { Console.WriteLine("Se ha registrado la foto de perfil". ); string httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); Console.WriteLine(httpResponseBody); } else{ Console.WriteLine("La foto de perfil no se ha registrado". ); string httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); Console.WriteLine(httpResponseBody); } } más { Console.WriteLine("Error al registrar la foto de perfil". ); Console.WriteLine(httpResponse.ToString()); } } |
[Introduzca la entrada correspondiente]
Entrada: ruta de acceso de la imagen\nombre del archivo de imagen
[Después de registrarse con éxito]
Parte 4. Registrar foto de perfil de usuario a través de Postman
[Ejemplo de solicitud]
[Ejemplo de respuesta: cuerpo]
