eConnect.EventsBridgeSdk 1.0.4

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

5. Usage

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...

6. Step-by-Step Guide

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