Nyxzie Core - DaemonX B2B Developer API
Service Name: Nyxzie Cloud Core - DaemonX Management & Telemetry API
Production Base URL:https://api.nyxzie.com/api/v1/daemonx
Transport: HTTPS with JSON payloads
1. Architectural Overview
While the DaemonX Local Bridge (http://127.0.0.1:9123) runs on individual Windows workstations to handle silent ESC/POS hardware spooling, the Nyxzie Core Cloud API serves as the central orchestration and management platform:
┌──────────────────────────────────────┐
│ B2B Merchant SaaS / Developer App │
└──────────────────┬───────────────────┘
│
│ HTTPS REST (Bearer nyx_daemonx_live_...)
▼
┌────────────────────────────────────────────────────────┐
│ Nyxzie Cloud Core API │
│ (/api/v1/daemonx/*) │
│ │
│ ├── Token Shield & Developer Tier Metering │
│ ├── Counter Registry & Device Configuration │
│ ├── Ephemeral Pairing Handshake Engine (Redis) │
│ └── Offline Lease Signing & Cryptographic Validation │
└──────────────────┬─────────────────────────────────────┘
│
│ Background Heartbeat & Lease Sync (60s/300s)
▼
┌────────────────────────────────────────────────────────┐
│ DaemonX Windows Workstation (127.0.0.1:9123) │
└────────────────────────────────────────────────────────┘
2. Authentication & Authorization
All B2B developer management endpoints are protected by DaemonX API Tokens issued from the Nyxzie Developer Portal:
2.1. Bearer Token Header
Requests must include the HTTP Authorization header:
Authorization: Bearer nyx_daemonx_live_6b431eda073e6cb462bd0a9971687376ef5481887c46dfa688bcb618982fc905
| Token Type | Prefix | Description |
|---|---|---|
| Live | nyx_daemonx_live_ | Production token bound to live counters and billing meters. |
| Sandbox / Test | nyx_daemonx_sandbox_ | Development token isolated from production quotas and live transactions. |
2.2. Endpoint Scope
DaemonX developer tokens are also restricted by endpoint group. A token must include the relevant group in its allowed_endpoints list:
| Endpoint Group | Allows |
|---|---|
/api/v1/daemonx/counters | GET /api/v1/daemonx/counters |
/api/v1/daemonx/onboarding/sessions | Session creation, status lookup, cancellation, and webhook replay. |
If the token is valid but does not include the required endpoint group, Core returns 403 DAEMONX_ENDPOINT_NOT_ALLOWED.
2.3. Error Responses & Envelopes
Responses follow a standard JSON envelope:
Success Envelope
{
"success": true,
"counters": [ ... ]
}
Error Envelope
{
"success": false,
"error": "Human-readable error description",
"code": "ERROR_CODE"
}
3. Developer Endpoints Index
Counters Management
| Method | Endpoint | Document Link | Description |
|---|---|---|---|
GET | /api/v1/daemonx/counters | 01_GET_api_v1_daemonx_counters.md | Query, list, and filter registered counters by location or external reference. |
Onboarding Sessions & Pairing
| Method | Endpoint | Document Link | Description |
|---|---|---|---|
POST | /api/v1/daemonx/onboarding/sessions | 02a_POST_api_v1_daemonx_onboarding_sessions.md | Initiate an onboarding session & generate a 6-digit desktop pairing code. |
GET | /api/v1/daemonx/onboarding/sessions/:id | 02b_GET_api_v1_daemonx_onboarding_sessions_id.md | Query onboarding session status and resolve paired counter UUID. |
POST | /api/v1/daemonx/onboarding/sessions/:id/cancel | 02c_POST_api_v1_daemonx_onboarding_sessions_cancel.md | Cancel an active or pending onboarding pairing session. |
POST | /api/v1/daemonx/onboarding/sessions/:id/webhook/replay | 02d_POST_api_v1_daemonx_onboarding_sessions_webhook_replay.md | Request outbox redelivery of completion webhook for completed session. |