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á la función a continuación:
- Registrar Visual Face a través de la API de envío de correo electrónico
- Registrar Visual Face a través de Face Scanning por un dispositivo (FaceStation F2)
A través de este artículo, puede aprender cómo llamar a una función API para registrar Visual Face a los usuarios en el servidor BioStar 2. Hay 2 formas diferentes de registrar Visual Face a través de la nueva API local.
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.
*Debe tener la configuración de nube configurada para usar la función Enviar correo electrónico para registrar Visual Face.
Para configurar CLOUD SETTING, consulte el siguiente artículo:
- https://kb.supremainc.com/knowledge/doku.php?id=en:how_to_use_mobile_app
*Debe tener la configuración de correo electrónico configurada para usar la función Enviar correo electrónico para registrar Visual Face.
Para configurar email setting, siga las instrucciones a continuación:
- Vaya a Configuración de > de Biostar 2 > CONFIGURACIÓN DE CORREO ELECTRÓNICO
- Haga clic en 'Configuración SMTP' e ingrese el valor apropiado para la opción SMTP.
- Habilite 'Inscripción móvil de Visual Face' y complete las opciones adicionales (Título del correo electrónico, Nombre de la empresa, Logotipo de la empresa, Contacto) si desea configurarlas para sus correos electrónicos.
- Y por último, el usuario debe tener su correo electrónico registrado.
- Para obtener una descripción detallada de cómo configurar la configuración de SMTP y la configuración de inscripción de Visual Face Mobile, visite https://support.supremainc.com/a/solutions/articles/24000060147?lang=en .
Parte 1. Llamada a la API y parámetros
[POST]: /api/v2/send_email
[Parámetros]
Nombre | Tipo | *M/O | Explicación | Valor |
Identificación | Cuerda | O | Id del usuario seleccionado |
|
Idioma | Cuerda | O | Idioma seleccionado en el que se escribirá el correo electrónico | "en" para inglés |
* M – Obligatorio, O – Opcional
Parte 2. Cuerpo de solicitud y modelo de respuesta
[Ejemplo de modelo de valor/parámetros]
{ "id": "2", "idioma": "en" } |
[Modelo de respuesta]
{ "código": "0", "httpResponseStatus": 200 } |
[Respuesta: Fallo]
{ "código": "1000" } |
[Respuesta: Exitosa]
{ "código": "0" } |
Parte 3. Ejemplo de consola
[Envío de correo electrónico (para registro visual Face) Código fuente del método]
static async void EmailVisualFaceReg() { Console.WriteLine("*****EmailVisualFaceReg 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(new Uri("https://127.0.0.1"), new Cookie("bs-session-id",sessionID)); ListUsers(); Console.WriteLine("Seleccione el ID de usuario para el registro de Visual Face por correo electrónico..."); string userID = Console.ReadLine(); string resourceAddress = "https://127.0.0.1/api/v2/send_email/";
JavaScriptSerializer serializer = nuevo JavaScriptSerializer();
string payload = "{ \"id\": \"" + userID + "\", \"language\": \"en\"}"; Console.WriteLine(carga útil); StringContent sc = new StringContent(payload, Encoding.UTF8, "application/json"); HttpResponseMessage httpResponse = await httpClient.PostAsync(resourceAddress, sc); HttpResponseMessage httpResponse = httpClient.PostAsync(resourceAddress, sc). Resultado;
if (httpResponse.IsSuccessStatusCode == true) { Console.WriteLine("Correo electrónico enviado. Revise su correo electrónico". ); string httpResponseBody = await httpResponse.Content.ReadAsStringAsync(); Console.WriteLine(httpResponseBody); } más { Console.WriteLine("Error en el envío de correo electrónico". ); Console.WriteLine(httpResponse.ToString()); } } |
[Envío de correo electrónico (para el registro visual de la cara) con éxito]
[Correo electrónico recibido]
Parte 4. Registrar Visual Face a través de Postman
[Solicitud]
*Debes introducir el User_ID con el correo electrónico ya registrado.
[Cuerpo de respuesta: Éxito]
