Skip to content

About

All documentation for System Locker's APIs.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

5 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 

Repository files navigation

System Locker Documentation

Reference documentation for the System Locker authentication, authorization, server-side variable, and management APIs. The same documentation is rendered at systemlocker.net/documentation.

Documentation index

The documentation is split into focused pages:

  • Simple API for direct checks from trusted server-side environments.
  • Bedrock for connected software running on user-controlled hardware.
  • Nightflyer for software that must keep working offline after authorization.
  • Quicksilver for existing production session-authentication integrations.
  • Server-side Variables.
  • Management API.
  • SL-HWID for the fault-tolerant hardware identifier used by Bedrock and Nightflyer.

Every request to System Locker APIs must be an HTTP POST request. Body parameters vary by endpoint.

Account authentication supports Google SSO on the Simple API, Quicksilver, and Bedrock. Libraries must surface the SSO link, obtain the resulting system-specific password from the customer, and retry authentication as described in Simple API and Bedrock.

Client libraries

Official client libraries that implement these APIs:

Library Protocol Language
System Locker Bedrock C++ Bedrock C++
System Locker Bedrock .NET Bedrock C# / .NET
System Locker Bedrock Go Bedrock Go
System Locker Bedrock NodeJS Bedrock Node.js
System Locker Bedrock Python Bedrock Python
System Locker Simple C++ Simple API C++
System Locker Simple .NET Simple API C# / .NET
System Locker Simple Go Simple API Go
System Locker Simple NodeJS Simple API Node.js
System Locker Simple Python Simple API Python

Pick a Bedrock library for software running on machines you don't control: every response is Ed25519-signed and verified against a pinned public key, with rolling session tokens and heartbeats. Bedrock libraries also include Invisible Folder file delivery (download, downloadToFile, downloadIfNew) for protected downloads and auto-updates.

Pick a Simple library when one stateless check per action is enough. The Simple libraries also wrap the Management API for key generation, expiry adjustment, and HWID resets from your own tooling.

Use Nightflyer when desktop software must keep working without a connection after its initial authorization; see the Nightflyer reference. The SL-HWID library provides the fault-tolerant hardware identifier used by Bedrock and Nightflyer, standalone for C++20 and .NET 8 applications.

About

All documentation for System Locker's APIs.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors