BioLogreen.Sdk 0.1.0

BioLogreen C# (.NET) SDK

The official C#/.NET SDK for the BioLogreen Facial Authentication API.

This SDK is a .NET Standard 2.0 class library, ensuring maximum compatibility with a wide range of .NET platforms, including .NET Framework, .NET Core/5/6/7/8+, MAUI, and Unity.

Features

• Cross-Platform: Built on .NET Standard 2.0 for broad compatibility.
• Modern & Asynchronous: Uses async/await with Task for non-blocking, efficient network operations.
• Robust & Type-Safe: Built with modern C# features and includes XML documentation.
• Resource-Safe: Implements IDisposable for proper management of network connections.
• No Heavy Dependencies: Uses the built-in HttpClient and System.Text.Json for high performance.

Installation

This SDK is intended to be published to the NuGet package manager. To install it, you can use the .NET CLI:

dotnet add package BioLogreen.Sdk --version 0.1.0 #or the latest version



Or, you can add it to your .csproj file directly:

XML

<ItemGroup>
  <PackageReference Include="BioLogreen.Sdk" Version="0.1.0" />
</ItemGroup>
Usage
The BioLogreenClient is designed to be instantiated once and reused throughout your application's lifecycle. It is thread-safe.

Here is a basic example for a console application.

C#

using BioLogreen.Sdk;
using BioLogreen.Sdk.Exceptions;
using BioLogreen.Sdk.Models;
using System;
using System.Collections.Generic;
using System.IO;
using System.Net.Http;
using System.Threading.Tasks;

public class Program
{
    // C# supports async Main methods, which is perfect for our SDK.
    public static async Task Main(string[] args)
    {
        // It is recommended to load your API key from environment variables or a secure config.
        var apiKey = "YOUR_SECRET_API_KEY";
        
        // Use a using statement to ensure the HttpClient is properly disposed.
        using var client = new BioLogreenClient(apiKey, "http://localhost:8000/v1"); // Use local URL for testing

        try
        {
            // --- Example: Signing up a new user ---
            Console.WriteLine("Attempting to sign up a new user...");
            var signupImageBytes = await File.ReadAllBytesAsync("path/to/user_signup_image.jpg");
            var customData = new Dictionary<string, object>
            {
                { "plan", "premium" },
                { "userId", "user-123" }
            };

            FaceAuthResponse signupResponse = await client.SignupWithFaceAsync(signupImageBytes, customData);

            Console.WriteLine("Signup Successful!");
            Console.WriteLine($"New User ID: {signupResponse.UserId}");
            Console.WriteLine($"Is New User: {signupResponse.IsNewUser}");
            Console.WriteLine($"Custom Fields Count: {signupResponse.CustomFields?.Count}");

            // --- Example: Logging in an existing user ---
            Console.WriteLine("\nAttempting to log in the user...");
            var loginImageBytes = await File.ReadAllBytesAsync("path/to/user_login_image.jpg");

            FaceAuthResponse loginResponse = await client.LoginWithFaceAsync(loginImageBytes);

            Console.WriteLine("Login Successful!");
            Console.WriteLine($"User ID: {loginResponse.UserId}");
        }
        catch (BioLogreenApiException ex)
        {
            Console.WriteLine($"API Error: {ex.Message} (Status Code: {ex.StatusCode})");
        }
        catch (HttpRequestException ex)
        {
            // This catches network-level errors (e.g., server is down)
            Console.WriteLine($"Network Error: {ex.Message}");
        }
        catch (IOException ex)
        {
            // This catches file-level errors (e.g., image not found)
            Console.WriteLine($"File Error: {ex.Message}");
        }
    }
}
Contributing
Suggestions and contributions are welcome. Please open an issue or a pull request on the GitHub repository to suggest changes.

License
This SDK is licensed under the MIT License with The Commons Clause. See the LICENSE file for more details.