Documentation menu

Getting started

Quick start

Go from a new account to a validated license in about ten minutes.

1. Create a product

Open Products and create one product for each app you sell. Licenses always belong to a product, so a key for one app never unlocks another.

Build in test mode

Use the environment switcher in the sidebar to move to Test. Test licenses and keys are completely separate from live ones, so you can experiment freely.

2. Create a policy

A policy is a template for the terms you sell, such as “Annual, 3 devices” or “14-day trial”. Open Policies, pick your product, and set the license type, duration, and device limit. You can skip this and set terms per license, but policies keep things consistent.

3. Issue a license

Open Licenses, select New license, choose the product and policy, and optionally add the customer's email.

Copy the key now

The full key is shown only once. If it's lost, revoke the license and issue a new one.

4. Copy your publishable key

Open the product and copy its publishable key. It starts with pk_test_ (or pk_live_) and is safe to ship inside your app. Also note the product ID (prod_…).

5. Activate a device

Install the SDK with npm install @atlas/sdk, then send the license key, product ID, and an ID that identifies this machine:

Your app
import { AtlasRuntime } from "@atlas/sdk";

const atlas = new AtlasRuntime({ publishableKey: "pk_test_..." });

const { data } = await atlas.activate({
  license_key: "ATLAS-7Q4M-...",       // what the customer typed
  product_id: "prod_...",
  device: { id: machineId, name: os.hostname() },
});

console.log(data.license.status);       // "active"
console.log(data.license.entitlements); // { plan: "pro", seats: 5 }

Open the license in the dashboard and you'll see the device under Activations. That's a working integration. Not using JavaScript? Every call is a plain HTTP request, listed in the API reference.