Librería de C# para BioEngine API

API principal para conectarse a los motores biométricos

• API version: f5895d
• SDK version: 1.0.0
• Generator version: 7.5.0
• Build package: org.openapitools.codegen.languages.CSharpClientCodegen

Frameworks soportados

• .NET Core >=1.0
• .NET Framework >=4.6
• Mono/Xamarin >=vNext

Dependencias

• RestSharp - 106.13.0 or later
• Json.NET - 13.0.2 or later
• JsonSubTypes - 1.8.0 or later
• System.ComponentModel.Annotations - 5.0.0 or later

Las DLLs incluidas en el paquete puede que no sean la última versión. Se recomienda usar NuGet para obtener la última versión de los paquetes:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

Instalación

Importar desde el repositorio Nuget proporcionado y después user los siguientes namespaces en el proyecto destino:

using BiometricsCore.Clients.Api;
using BiometricsCore.Clients.Client;
using BiometricsCore.Clients.Model;

Uso

Para usar el API con un Web Proxy, usar: System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Uso Básico

using System.Collections.Generic;
using System.Diagnostics;
using BiometricsCore.Clients.Api;
using BiometricsCore.Clients.Client;
using BiometricsCore.Clients.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "http://localhost";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DictamenApi(config);
            var operationsFilterDto = new OperationsFilterDto?(); // OperationsFilterDto? | DTO con criterios de búsqueda (optional) 

            try
            {
                // Busca operaciones de dictamen con los criterios especificados
                ResponseDto result = apiInstance.ApiDictamenBuscarPost(operationsFilterDto);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling DictamenApi.ApiDictamenBuscarPost: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

Documentación para los endpoints

Todas las URIs relativas a http://localhost

Clase	Método	Request HTTP	Descripción
DictamenApi	ApiDictamenBuscarPost	POST /api/Dictamen/Buscar	Busca operaciones de dictamen con los criterios especificados
DictamenApi	ApiDictamenGuardaDictamenPost	POST /api/Dictamen/GuardaDictamen	Actualiza el status de una dictaminación. Si se determina que son personas diferentes, se lanza le operación de inserción al motor biométrico. El dictamen solo se puede registrar una vez.
EngineApi	ApiEngineDeleteDelete	DELETE /api/Engine/Delete	Permite la eliminación de un Registro de la BD y del motor.
EngineApi	ApiEngineEnrollIdentifyASyncIdConfigPost	POST /api/Engine/EnrollIdentifyASync/idConfig	Operación asíncrona para Enrolar una Persona en el motor biométrico, haciendo una búsqueda de duplicados biométricos antes de permitir la inserción.
EngineApi	ApiEngineIdentifyASyncIdConfigPost	POST /api/Engine/IdentifyASync/idConfig	Operación asíncrona para Buscar una Persona en el motor biométrico (identificar) con base a los biométricos proporcionados. Regresa a través de los webhooks configurados los resultados de las operaciones
EngineApi	ApiEngineIdentifyIdConfigPost	POST /api/Engine/Identify/idConfig	Operación síncrona para Buscar una Persona en el motor biométrico (identificar) con base a los biométricos proporcionados. Espera a que el motor regrese el resultado.
EngineApi	ApiEngineVerifyIdConfigPost	POST /api/Engine/Verify/idConfig	Operación síncrona para verificar a una persona en el motor biométrico
JobApi	ApiJobGetJobIdJobGet	GET /api/Job/GetJob/idJob	Obtiene información de un Job específico

Documentación para los Modelos

• Model.BiometricDto
• Model.MatchResultDto
• Model.OperationDto
• Model.OperationsFilterDto
• Model.ResponseDto
• Model.SubjectDto

Documentación para Autorización

Esquemas de autenticación definidos en el API:

oauth2

Ambiente de Desarrollo

• Tipo: OAuth
• Flow: application
• Authorization URL: https://dev2.cosmokeys.cosmocolor.mx/realms/bioengine/protocol/openid-connect/auth
• Scopes: N/A

Ambiente de Producción

• Tipo: OAuth
• Flow: application
• Authorization URL: https://auth.cosmocolor.mx/realms/bioengine/protocol/openid-connect/auth
• Scopes: N/A