This folder includes:
- the SDK header
- a Visual Studio example project
- prebuilt MSVC binaries
- prebuilt MinGW binaries
The SDK works in three common setups:
AuthlyX.hdirectly in your project- prebuilt static library
- prebuilt DLL
If you are starting fresh, use the header method first. It is the quickest setup and it is the easiest one to debug.
- Windows desktop C++ project
- C++14 / C++17 / C++20 / C++23
Tested in this repository with:
- Visual Studio 2026 / MSVC
v145,v143,v142 - MinGW-w64 on MSYS2
If your toolchain already supports modern C++17 Windows development, you usually do not need anything special beyond the normal Windows SDK pieces your compiler already uses.
AuthlyX-CPP-Example/
|- AuthlyX.h
|- include/
| \- AuthlyX.h
|- src/
| \- AuthlyX.cpp
|- builds/
| |- MSVC/
| | |- x86/
| | \- x64/
| \- MinGW/
| |- x86/
| \- x64/
\- AuthlyX-CPP-Example/
\- main.cpp
AuthlyX.his the easiest include path for normal C++ projects.include/AuthlyX.his the main SDK implementation.src/AuthlyX.cppis used to build the static library and DLL outputs.AuthlyX-CPP-Example/main.cppis the reference example.
#include "AuthlyX.h"
int main() {
AuthlyX AuthlyXApp(
"12345678",
"MYAPP",
"1.0.0",
"your-secret"
);
if (!AuthlyXApp.Init()) {
return 1;
}
return 0;
}Optional constructor values:
AuthlyX AuthlyXApp(
"12345678",
"MYAPP",
"1.0.0",
"your-secret",
false,
"https://example.com/api/v2"
);debugdefaults totrueapidefaults tohttps://authly.cc/api/v2
Use this if you want the standard C++ class experience.
Steps:
- Copy
AuthlyX.hinto your project, or add the folder to your include path. - Include it where you need the SDK.
- Build your project normally.
#include "AuthlyX.h"This route is best for:
- console apps
- Win32 desktop apps
- WinForms/WPF native interop hosts
- internal tools
Notes:
- On MSVC, the required Windows libraries are linked automatically by the header.
- On MinGW, link your normal Windows system libraries if your project does not already pull them in.
Use this if you want faster rebuilds or you prefer shipping a compiled SDK instead of the full implementation header.
For MSVC:
builds/MSVC/x86/AuthlyX.libbuilds/MSVC/x64/AuthlyX.lib
For MinGW:
builds/MinGW/x86/libAuthlyX.abuilds/MinGW/x64/libAuthlyX.a
Setup:
- Add
AuthlyX.hto your include path. - Define
AUTHLYX_SOURCE_BUILDbefore including the header in the file that talks to the binary SDK. - Link the matching static library for your compiler and architecture.
Example:
#define AUTHLYX_SOURCE_BUILD
#include "AuthlyX.h"Important:
- Match your compiler family to the binary you use.
- Match
x86withWin32, andx64withx64. - On MSVC, use the normal DLL runtime setting used by modern Visual Studio projects.
Use this when you want to update the SDK without rebuilding the host project.
For MSVC:
- import library:
builds/MSVC/_import/x86/AuthlyX.import.lib - import library:
builds/MSVC/_import/x64/AuthlyX.import.lib - runtime DLL:
builds/MSVC/x86/AuthlyX.dll - runtime DLL:
builds/MSVC/x64/AuthlyX.dll
For MinGW:
- import library:
builds/MinGW/_obj/x86/libAuthlyX.import.a - import library:
builds/MinGW/_obj/x64/libAuthlyX.import.a - runtime DLL:
builds/MinGW/x86/AuthlyX.dll - runtime DLL:
builds/MinGW/x64/AuthlyX.dll
Setup:
- Add
AuthlyX.hto your include path. - Define
AUTHLYX_USE_DLLbefore including the header. - Link the matching import library.
- Place the matching
AuthlyX.dllbeside your executable.
Example:
#define AUTHLYX_USE_DLL
#include "AuthlyX.h"If you are distributing the DLL build, make sure the correct runtime files for that compiler family are present on the target machine.
AuthlyXApp.Login("username", "password");AuthlyXApp.Login("XXXXX-XXXXX-XXXXX-XXXXX-XXXXX");AuthlyXApp.Login("YOUR_MOTHERBOARD_ID", "", "motherboard");
AuthlyXApp.Login("YOUR_PROCESSOR_ID", "", "processor");Init()Login(identifier, password = "", deviceType = "")Register(username, password, licenseKey, email = "")ChangePassword(oldPassword, newPassword)ExtendTime(username, licenseKey)GetVariable(key)SetVariable(key, value)Log(message)GetChats(channelName)SendChat(message, channelName = "")ValidateSession()
SDK logging is enabled by default.
Logs are written to:
C:\ProgramData\AuthlyX\{AppName}\YYYY_MM_DD.log
To disable logs:
AuthlyX AuthlyXApp(
"12345678",
"MYAPP",
"1.0.0",
"your-secret",
false
);Sensitive request values are masked automatically before they are written to disk.
- If you only need the class-based SDK,
AuthlyX.his usually the best choice.