FaceDeviceSDK.FacePass 1.0.0

FaceDeviceSDK.FacePass

.NET SDK для интеграции устройств FacePass в приложения ASP.NET Core.

Установка

dotnet add package FaceDeviceSDK.FacePass

Что нужно для работы

Перед использованием подготовьте:

• URL устройства FacePass или API-шлюза, например http://192.168.1.100
• deviceKey
• secret
• ASP.NET Core приложение на .NET 10+

1. Добавьте настройки в appsettings.json

{
  "FacePass": {
    "BaseUrl": "http://192.168.1.100",
    "DeviceKey": "YOUR_DEVICE_KEY",
    "Secret": "YOUR_SECRET"
  }
}

2. Подключите SDK в Program.cs

using FacePass;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddControllers();

var facePassBaseUrl = builder.Configuration["FacePass:BaseUrl"]
    ?? throw new InvalidOperationException("FacePass:BaseUrl is not configured.");

builder.Services.AddFacePassService(facePassBaseUrl);

var app = builder.Build();

app.MapControllers();
app.Run();

После этого сервис IFacePassService будет доступен через dependency injection.

3. Пример использования в ASP.NET Core контроллере

using FacePass.Interfaces;
using FacePass.Models;
using Microsoft.AspNetCore.Mvc;

[ApiController]
[Route("api/facepass/device")]
public sealed class FacePassDeviceController(
    IFacePassService facePassService,
    IConfiguration configuration) : ControllerBase
{
    [HttpPost("restart")]
    public async Task<IActionResult> Restart()
    {
        var request = new BaseHFRequest
        {
            deviceKey = configuration["FacePass:DeviceKey"]
                ?? throw new InvalidOperationException("FacePass:DeviceKey is not configured."),
            secret = configuration["FacePass:Secret"]
                ?? throw new InvalidOperationException("FacePass:Secret is not configured.")
        };

        var response = await facePassService.DeviceRestart(request);
        return Ok(response);
    }

    [HttpPost("open-door")]
    public async Task<IActionResult> OpenDoor()
    {
        var request = new BaseHFRequest
        {
            deviceKey = configuration["FacePass:DeviceKey"]
                ?? throw new InvalidOperationException("FacePass:DeviceKey is not configured."),
            secret = configuration["FacePass:Secret"]
                ?? throw new InvalidOperationException("FacePass:Secret is not configured.")
        };

        var response = await facePassService.DeviceOpening(request);
        return Ok(response);
    }
}

4. Callback endpoints от устройства

Если устройство отправляет heartbeat и события идентификации в ваше приложение, можно добавить такой контроллер:

using FacePass.Models;
using Microsoft.AspNetCore.Mvc;

[ApiController]
[Route("api/facepass/callbacks")]
public sealed class FacePassCallbacksController : ControllerBase
{
    [HttpPost("heartbeat")]
    public IActionResult Heartbeat([FromForm] HeartbeatInfo model)
    {
        // Сохранение состояния устройства
        return Ok();
    }

    [HttpPost("identify")]
    public IActionResult Identify([FromForm] IdentifyInfo model)
    {
        // Обработка события идентификации
        return Ok();
    }
}

Если устройство присылает JSON, используйте [FromBody] вместо [FromForm].

Что умеет SDK

Через IFacePassService доступны методы для:

• настройки устройства;
• перезагрузки, сброса и открытия двери;
• управления callback URL;
• регистрации и удаления фотографий;
• управления сотрудниками;
• настройки рекламы, изображений и пользовательских параметров;
• получения событий heartbeat и identify.

Лицензия

Использование разрешено, но модификация исходного кода запрещена.

Полный текст лицензии: LICENSE.txt

Репозиторий

https://github.com/taalaibekdev/FaceDeviceSDK