eConnect.EventsBridgeSdk 1.3.0

eConnect.EventsBridgeSdk

Overview

eConnect.EventsBridgeSdk is a robust SDK designed to seamlessly integrate with the eConnect system, enabling efficient management of face and license plate detections. It provides real-time callbacks when faces or plates are detected, ensuring your applications can respond promptly to these events.

Features

• Face Detection Management: Enroll, monitor, and manage face detections within the eConnect system.
• License Plate Detection Management: Handle license plate detections with ease.
• Automatic Token Renewal: The SDK manages authentication tokens, automatically renewing them as needed to maintain secure connections.
• Asynchronous Operations: Leverage async methods for non-blocking operations and improved performance.
• Comprehensive Logging: Integrates with Microsoft.Extensions.Logging for detailed logging and diagnostics.

Installation

You can install the eConnect.EventsBridgeSdk package via the .NET CLI or the Package Manager Console.

Using .NET CLI

dotnet add package eConnect.EventsBridgeSdk --version 1.0.0

or

Install-Package eConnect.EventsBridgeSdk -Version 1.0.0-beta20241216191556

Supported Frameworks

• .NET Standard 2.0
• .NET Standard 2.1
• .NET 8.0

Usage

Below is a basic example of how to initialize and use the eConnect.EventsBridgeSdk:

using eConnect.EventsBridge.Sdk;
using Microsoft.Extensions.Logging;

// Initialize the SDK
var sdk = await eConnectEventsBridgeSdk.GetSdk(
    loggerFactory, 
    ServerAddress, 
    httpClient, 
    Username, 
    Password
);

// Check if already enrolled, and remove first if necessary
var enrolled = await sdk.FaceMonitorStatusCheckAsync(externalId);

// Additional SDK operations...

Step-by-Step Guide

1. Initialize the SDK:

   • Use the GetSdk method to create an instance of the SDK.
   • Provide the necessary parameters such as loggerFactory, ServerAddress, httpClient, Username, and Password.

2. Check Enrollment Status:

   • Use FaceMonitorStatusCheckAsync to verify if a face is already enrolled.
   • Handle the response accordingly, such as removing existing enrollments before adding new ones.

3. Manage Detections:

   • Utilize other SDK methods to manage face and license plate detections as per your application requirements.

Developer Documentation

Comprehensive developer documentation is available to help you get started and make the most out of the eConnect.EventsBridgeSdk.

• Developer Guides: eConnect Events Bridge Documentation

License

Released under the MIT License — free to use, including commercially, with no fee.

This licence covers this client SDK only. The eConnect Events Bridge server and the rest of the eConnect platform are proprietary, and nothing here grants access to an eConnect service — that is governed by your eConnect credentials and agreement.

Change History

• 1.3.0 - 2026.08.10

  • The SDK is now limited to the partner-facing API. It exposes local sign-in and token renewal, face monitoring, licence plate monitoring, and WebHook management — and nothing else.
  • Removed operations that were never intended for SDK consumers and are administrator-only on the server: tunnel-client controls, user administration, identity-server and classic-server configuration, FR rule tuning, and the browser and mobile sign-in flows belonging to the authentication platform. Calling any of them required an Admin role, so an SDK consumer could not have used them successfully.
  • The 12 data types belonging to those removed operations are no longer generated either (TunnelClientItem, UserInfoItem, IdentityServerItem, ClassicServerItem and similar).
  • LoginGETAsync has been removed rather than deprecated. It forwarded to the browser sign-in redirect, which is no longer part of the SDK. LoginPOSTAsync is unaffected and still forwards to AuthenticateLocalAsync.
  • The allow list lives in the client generator, so future endpoints are excluded by default — new endpoints under an existing partner route are picked up automatically, anything else has to be added deliberately.
  • Payload types are unchanged: WebHookFaceRecPayload, WebHookLprPayload, WebHookInfoItem and the full detection event model are all still generated, so deserialising the callbacks Events Bridge posts to you works exactly as before.

• 1.2.1 - 2026.08.10

  • Package now declares its licence (MIT). No code changes; 1.2.0 and earlier shipped with no licence metadata.

• 1.2.0 - 2026.08.10

  • Added WebHookGetAsync(hookId) — fetch a single WebHook by its id. Returns the hook to its owner (or to any Admin); any other id returns 404, including ids that belong to another account, so the endpoint cannot be used to probe for other users' WebHooks.
  • Renamed LoginPOSTAsync to AuthenticateLocalAsync, and LoginGETAsync to LoginAsync. Same endpoints, same payloads — only the method names changed, following a server-side rename needed for OIDC login routing. The old names still work: both remain available as [Obsolete] forwarders, so existing code keeps compiling and simply gets a deprecation warning naming the replacement. The forwarders will be removed in a future major version.
  • Added LocalSignOutAsync for clearing the local session cookie.
  • Added TestWebHookAsync(hookId) — posts a synthetic detection to a WebHook and reports what the receiver answered.
  • Added a net10.0 target and upgraded Microsoft.Extensions.Logging.Abstractions and System.IdentityModel.Tokens.Jwt. Targets remain netstandard2.0, netstandard2.1, net8.0 and net10.0.

  Upgrading from 1.0.5? Everything above is included. Version 1.1.0 was never released as a stable package — only 1.1.0-beta* prereleases — so 1.2.0 is the next stable release after 1.0.5.

• 1.0.5 - 2025.02.12

  • Renamed PersonDetectionEventFieldInfo to PersonDetectionEventFieldInfoItem
  • Added Notes to type PersonDetectionEventPersonInfoItem