Nyckelformat
apm_<48 base62> (SHA-256)
RBAC-behörigheter
full, read + 12 granulära
Control Plane
7 API-domäner + /enterprise
Telemetri & händelser
HMAC Webhooks + Prometheus

1. Autentisering, nyckelgenerering & säkerhetskontroller

Varje Apium Cloud OS-nod exponerar sitt kontrollplan under en isolerad konsolsökväg (/<console>/api/v1/...). Förfrågningar accepterar autentiseringsuppgifter via antingen X-API-Key: apm_... eller Authorization: Bearer apm_....

  • Nyckelgenerering med hybrid-entropi: När en nyckel utfärdas i gränssnittet samlar webbläsaren in musrörelsekoordinater och tidpunkter (client_entropy) blandat med crypto.getRandomValues. Servern kombinerar den nyttolasten med två 32-teckens CSPRNG-strängar och en nanosekund-tidsstämpel via SHA-256, vilket producerar en apm_<48 base62>-token.
  • Engångsvisning i klartext & hashad lagring: Den råa apm_...-token visas exakt en gång vid skapandet. Endast dess SHA-256-hash lagras i api_keys-lagret.
  • Nätverks- & livstidsbegränsningar: Varje nyckel stöder en IP-allowlist (allowed_ips) och en automatisk utgångstidsstämpel (expires_at).
  • Granskningslogg & OpenAPI: Varje API-anrop registreras i granskningsloggen (GET /api/v1/api-audit), och noden exporterar en maskinläsbar OpenAPI-specifikation (apium-cloud-os-openapi.json) för SDK-generering.

2. RBAC-behörighetsmatris & licensnivåer

Istället för allt-eller-inget-admintokens upprätthåller Apium Cloud OS principen om minsta privilegium via kommaseparerade behörigheter (scopes). På den kostnadsfria utgåvan Lite tillåts endast read-åtkomst; full och alla skrivbehörigheter kräver Pro, Ultra eller Extra.

API-nyckelbehörigheter & profiler för minsta privilegium

Åtkomstkontroll

Kombinera globala eller resursnivåbehörigheter för att isolera faktureringsbotar, SRE-övervakare och HR-automatisering.

Scope / MönsterÅtkomstnivåTypisk operativ nyckelprofil
fullObegränsad läsning & skrivning över alla domäner (Pro/Ultra/Extra)Masterorkestrator eller dedikerad IaC-kontroller
readGlobal skrivskyddad åtkomst över resurser (exklusive /system/config)Centraliserad flottobservatör eller extern BI-panel
users:read / users:writeLäsa konton & sessioner / skapa, förlänga, återkalla, kasta ut & bulk-operationerTelegram- & SaaS-faktureringsbotar, HR/IAM-onboarding
groups:read / groups:writeInspektera användargrupper / tilldela och ändra gruppolicyerAvdelningsbaserad företagsåtkomstautomatisering
plans:read / plans:writeLista tariffplaner / skapa/ta bort planer & tillämpa trafikshaperKommersiell tariffsynkronisering och bandbreddspolicymotor
webhooks:read / webhooks:writeLista webhook-mål / registrera eller ta bort HMAC-endpointsAutomatiserad händelsebuss-provisionering per hyresgäst
monitoring:readÅtkomst till /overview, /health, /metrics, /sessions, /logs, /api-auditPrometheus-scrapers, Grafana, SIEM & SOC-insamlare
system:read / system:writeSystemstatus / kaskadläge, uppströms, tjänster & säkerhetslägeSRE-failoverautomatisering & livscykelskript för tjänster

3. Komplett endpointkarta över 7 kontrolldomäner

Alla administrativa rutter finns under /<console>/api/v1 och täcker nodens fulla operativa yta:

Endpoints grupperade efter funktionell domän

API-yta

Varje delsystem som hanteras i webbgränssnittet exponeras för deterministisk API-automatisering.

DomänViktiga endpointsKapacitet
Användare & bulklivscykelGET/POST /users, GET /users/generate, POST /users/bulk-create, POST /users/bulk-extendSkapa konton, batch-provisionera flottor och massförlänga kvoter eller TTL
Kontroll per användareGET /users/:id/config, POST /users/:id/extend|revoke|restore|reset-traffic|rotate-token|kick, PUT /users/:id/group|expiration|restrictions, GET /users/:id/sessionsHämta klientkonfigurationer, rotera tokens, kasta ut aktiva sessioner och finjustera gränser per användare
Planer & shaperGET/POST /plans, DELETE /plans/:id, POST /shaper/applyHantera tariffmallar och skicka ut live-regler för bandbredd/shaper
Kaskad & uppströmsPUT /cascade/mode, POST /upstreams/check, POST /upstreams/:id/toggle, POST /upstreams/:id/reset-trafficVäxla kaskadroutinglägen, proba utgångsnoder, slå på/av uppströms, nollställ räknare
Övervakning & granskningGET /overview, GET /health, GET /metrics, GET /sessions, POST /sessions/:id/kick, GET/DELETE /logs, POST /logs/simulate, GET /api-auditHälsokontroller, Prometheus-telemetri, avslutning av livesessioner och API-granskningsloggar
Webhooks & nycklarGET/POST /webhooks, DELETE /webhooks/:id, GET/POST /api-keys, DELETE /api-keys/:idProgrammatisk livscykel för HMAC-webhookprenumeranter och behörighetsstyrda API-nycklar
Tjänster, säkerhet & licensPOST /services/toggle|restart|update-adblock|unban-ip|clear-auth-logs, PUT /settings/security-mode, GET /license/status, POST /license/activateDemonkontroll, avblockering av IP i Fail2ban, AdBlock-uppdateringar och licensaktivering
Corporate GatewayGET /enterprise/overview, POST /enterprise/users/:id/toggle, .../enterprise/users/:id, .../enterprise/gateways/:idDedikerat kontrollplan för Corporate Gateway-användare och gatewaynoder

4. Praktiska exempel på förfrågningar & händelser

A. Bulk-provisionering & förlängning av användare

Skapa konton bundna till en tariffplan (plan_id), kör batch-provisionering eller förläng prenumerationer med automatisk återställning (auto_restore: true) utan att starta om transportkärnor:

curl -X POST -H "X-API-Key: apm_..." \
  -H "Content-Type: application/json" \
  -d '{"username":"client_9042","plan_id":1}' \
  https://node.apium.cloud/<console>/api/v1/users

curl -X POST -H "Authorization: Bearer apm_..." \
  -H "Content-Type: application/json" \
  -d '{"add_days":30,"add_quota_gb":100,"auto_restore":true}' \
  https://node.apium.cloud/<console>/api/v1/users/42/extend

B. Publik prenumerations-endpoint (standardiserade klientheaders)

Klientappar som v2rayNG, Nekobox, Streisand och Hiddify hämtar en enda tokeniserad URL som returnerar Base64-profiler tillsammans med standardheaders för kvot och utgångstid:

GET /<console>/api/v1/subscriptions/<sub_token>

< HTTP/1.1 200 OK
< Profile-Title: Apium Cloud OS
< Profile-Update-Interval: 12
< Subscription-Userinfo: upload=104857600; download=2147483648; total=107374182400; expire=1798761600

C. HMAC-SHA256-signerade webhooks

Istället för att polla noden med några sekunders mellanrum, konfigurera din faktureringsbackend eller ditt CRM att ta emot push-händelser i realtid verifierade med X-Apium-Signature:

POST https://billing.example.com/webhooks/apium
X-Apium-Event: user.created
X-Apium-Signature: sha256=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08

{
  "event": "user.created",
  "timestamp": "2026-11-14T12:30:00Z",
  "data": { "user": { "id": 42, "username": "client_9042", "protocol": "hysteria2" } }
}

D. Prometheus-metrik (GET /api/v1/metrics)

Koppla in din flotta direkt till Prometheus och Grafana med en monitoring:read-nyckel för att spåra aktiva sessioner, användarantal och RTT för uppströms-kaskader:

# TYPE apium_active_sessions gauge
apium_active_sessions 1248
# TYPE apium_users_total gauge
apium_users_total{status="active"} 3410
# TYPE apium_upstream_latency_ms gauge
apium_upstream_latency_ms{id="1",name="NL-AMS-01"} 18

5. Verkliga integrationsscenarier

Där Apium Cloud OS API briljerar

Integrationsmönster

Vanliga produktionsarkitekturer byggda ovanpå Apium REST API, RBAC-nycklar, Webhooks och Prometheus.

ScenarioAnvända API-primitiverOperativ fördel
Telegram-botar & SaaS-faktureringusers:write-nyckel + POST /users, /users/bulk-create, /extend, Subscriptions + WebhooksOmedelbar nyckelleverans efter betalning, automatiska förnyelser, noll manuellt adminarbete
Företags HR / IAM-onboardingusers:write + groups:write + POST /users/:id/kick & /enterprise/...Automatisk VPN-åtkomst vid anställning och omedelbar återkallelse av sessioner vid avslut
Flott-SRE & övervakningmonitoring:read-nyckel + GET /metrics, /health, /api-audit + IP-allowlistGrafana-paneler och larm utan att exponera skrivrättigheter
Kaskad- & shaperautomatiseringsystem:write + plans:write + PUT /cascade/mode, POST /upstreams/check, POST /shaper/applyDynamisk failover över utgångsländer och automatiserad bandbreddsstyrning