Skip to content

README.md

Latest commit

 

History

History
339 lines (246 loc) · 6.79 KB

README.md

File metadata and controls

339 lines (246 loc) · 6.79 KB
Raw

AuthlyX C# SDK

This is a C# authentication SDK for desktop and .NET applications that want simple integration with the AuthlyX API.

This package is for SDK users. The Console and WinForms apps in the example folder are only reference examples to help you integrate faster.

Supported Targets

The SDK supports:

  • .NET Framework 4.8
  • .NET Standard 2.0
  • .NET
  • .NET Core

Modern .NET and .NET Core projects can consume the netstandard2.0 build.

Installation

Choose the setup that fits your project.

1. NuGet package installation

This is the quickest option and the easiest one to maintain.

Install the package from NuGet:

Install-Package AuthlyX

Or with the .NET CLI:

dotnet add package AuthlyX

Once installed, import the namespace in your project:

using AuthlyX;

Use this option if you want package updates, clean dependency management, and the simplest setup.

2. Class installation

If you prefer to keep the SDK as a source file inside your project, you can add AuthlyX.cs manually.

Steps:

  1. Download AuthlyX.cs.
  2. Add it to your project.
  3. Install the required dependencies manually:
    • Newtonsoft.Json
    • Portable.BouncyCastle
  4. Import the namespace:
using AuthlyX;

You can install the dependencies with NuGet Package Manager:

Install-Package Newtonsoft.Json
Install-Package Portable.BouncyCastle

Or with the .NET CLI:

dotnet add package Newtonsoft.Json
dotnet add package Portable.BouncyCastle

This option works well if you want the SDK source directly in your solution and prefer to manage updates yourself.

3. DLL installation

If you already have a compiled AuthlyX.dll, you can reference it manually instead of installing the full package through NuGet.

Steps:

  1. Build or obtain AuthlyX.dll.
  2. In Visual Studio, right-click References or Dependencies.
  3. Choose Add Reference.
  4. Browse to AuthlyX.dll and add it.
  5. Make sure your project also has the required dependencies:
    • Newtonsoft.Json
    • Portable.BouncyCastle
  6. Import the namespace:
using AuthlyX;

This option is useful when you want to ship or test a specific SDK build without pulling from NuGet.

Quick Start

public static Auth AuthlyXApp = new Auth(
    ownerId: "12345678",
    appName: "MYAPP",
    version: "1.0.0",
    secret: "qIBFoBJWQH4jaOZr6Sf8BJZyEVnT0LiN4QfGxJGn"
);

/*
Optional:
- Set debug to false to disable SDK logs.
- Set api to your custom domain, for example: https://example.com/api/v2
*/

Then initialize:

AuthlyXApp.Init();

Optional Parameters

public static Auth AuthlyXApp = new Auth(
    ownerId: "12345678",
    appName: "MYAPP",
    version: "1.0.0",
    secret: "qIBFoBJWQH4jaOZr6Sf8BJZyEVnT0LiN4QfGxJGn",
    debug: false,
    api: "https://example.com/api/v2"
);

Available options

  • debug

    • Default: true
    • Set false to disable SDK logs

  • api

    • Default: https://authly.cc/api/v2
    • Use this for your custom domain

Available Methods

  • Init()
  • Login(identifier, password = null, deviceType = null)
  • Register(username, password, licenseKey, email = null)
  • ChangePassword(oldPassword, newPassword)
  • ExtendTime(username, licenseKey)
  • GetVariable(key)
  • SetVariable(key, value)
  • Log(message)
  • GetChats(channelName)
  • SendChat(message, channelName = null)
  • ValidateSession()

Authentication Example

// Username + password
AuthlyXApp.Login("username", "password");

// License key only
AuthlyXApp.Login("XXXXX-XXXXX-XXXXX-XXXXX-XXXXX");

// Device login
AuthlyXApp.Login("YOUR_MOTHERBOARD_ID", deviceType: "motherboard");

The SDK routes Login(...) automatically:

  • password + identifier for username login
  • identifier only for license login
  • deviceType + identifier for device login

Username Login Example

AuthlyXApp.Login("username", "password");

if (AuthlyXApp.response.success)
{
    Console.WriteLine("Login success");
    Console.WriteLine(AuthlyXApp.userData.Username);
    Console.WriteLine(AuthlyXApp.userData.SubscriptionLevel);
}
else
{
    Console.WriteLine(AuthlyXApp.response.message);
}

userData.SubscriptionLevel is populated automatically after username, license, and device authentication flows.

License Login Example

AuthlyXApp.Login("XXXXX-XXXXX-XXXXX-XXXXX-XXXXX");

if (AuthlyXApp.response.success)
{
    Console.WriteLine("License login success");
}
else
{
    Console.WriteLine(AuthlyXApp.response.message);
}

Device Login Example

Motherboard

AuthlyXApp.Login("YOUR_MOTHERBOARD_ID", deviceType: "motherboard");

if (AuthlyXApp.response.success)
{
    Console.WriteLine("Motherboard login success");
}
else
{
    Console.WriteLine(AuthlyXApp.response.message);
}

Processor

AuthlyXApp.Login("YOUR_PROCESSOR_ID", deviceType: "processor");

if (AuthlyXApp.response.success)
{
    Console.WriteLine("Processor login success");
}
else
{
    Console.WriteLine(AuthlyXApp.response.message);
}

Variable Example

AuthlyXApp.SetVariable("theme", "dark");

string value = AuthlyXApp.GetVariable("theme");
Console.WriteLine(value);

Change Password Example

AuthlyXApp.ChangePassword("oldpass", "newpass");

if (AuthlyXApp.response.success)
{
    Console.WriteLine("Password changed successfully");
}
else
{
    Console.WriteLine(AuthlyXApp.response.message);
}

Chat Example

AuthlyXApp.SendChat("Hello world", "MAIN");

string chats = AuthlyXApp.GetChats("MAIN");
Console.WriteLine(chats);

Non-Blocking UI Usage

For WinForms or UI apps, use the callback overloads so the app does not freeze:

AuthlyXApp.Login("user", "pass", callback: response =>
{
    if (response.success)
    {
        MessageBox.Show("Logged in");
    }
    else
    {
        MessageBox.Show(response.message);
    }
});

You can also use callback-based versions of the main methods, including:

  • Init
  • Login
  • Register
  • GetVariable
  • GetChats
  • ValidateSession

Logging

By default, SDK logging is enabled.

Logs are written to:

C:\ProgramData\AuthlyX\{AppName}\YYYY_MM_DD.log

To disable logs:

debug: false

Sensitive values such as passwords, secrets, and signatures are masked automatically.

Method Name Casing

The SDK accepts both PascalCase and lowercase method names.

Examples:

AuthlyXApp.Login("username", "password");
AuthlyXApp.login("username", "password");

AuthlyXApp.Init();
AuthlyXApp.init();

Notes

  • The SDK currently supports both sid and hwid for compatibility with older integrations.
  • If you are starting fresh, treat sid as the preferred system identifier concept.
  • The example apps in the example folder are reference integrations, not required project structure.