Skip to main content
The Customer API allows authenticated users to manage their OrbitFlare resources programmatically. It supports two versions: v1 (API key authentication only) and v2 (Bearer token or API key with extended features including auth flows, profile management, and invoice operations).

Authentication

OrbitFlare supports two authentication methods depending on the API version you are using. API Key (v1 & v2): Pass your API key via the X-ORBIT-KEY request header. This method works with both v1 and v2 endpoints. Bearer Token (v2 only): Obtained through the device authorization flow or wallet signature authentication. Pass the token in the standard Authorization: Bearer <token> header.
API keys work across both versions. If you only need basic license management, an API key is the simplest way to authenticate.
curl -X GET https://api.orbitflare.com/v2/licenses \
  -H "X-ORBIT-KEY: your-api-key-here"

API v2 Endpoints

Auth

Device flow, wallet auth, session management

Licenses

List, manage, and configure licenses

API Keys

Create, update, and manage API keys

Profile

View and update user profile

Invoices

View invoices and pay with balance

Legacy API v1

API v1 is deprecated and will be removed in a future release. Migrate to v2 for access to the full set of endpoints and improved authentication options.

v1 Customer Endpoints

Legacy license management endpoints

Migration Guide

Step-by-step guide to upgrading from v1 to v2