Nøkkelformat
apm_<48 base62> (SHA-256)
RBAC-omfang
full, read + 12 granulære
Control Plane
7 API-domener + /enterprise
Telemetri og hendelser
HMAC Webhooks + Prometheus

1. Autentisering, nøkkelgenerering og sikkerhetskontroller

Hver Apium Cloud OS-node eksponerer sitt kontrollplan under en isolert konsollbane (/<console>/api/v1/...). Forespørsler aksepterer legitimasjon via enten X-API-Key: apm_... eller Authorization: Bearer apm_....

  • Hybrid-entropi nøkkelgenerering: Når en nøkkel utstedes i UI-et, samler nettleseren inn musebevegelseskoordinater og tidspunkter (client_entropy) blandet med crypto.getRandomValues. Serveren kombinerer denne nyttelasten med to 32-tegns CSPRNG-strenger og et nanosekund-tidsstempel via SHA-256, og produserer et apm_<48 base62>-token.
  • Engangs klartekst og hashet lagring: Det rå apm_...-tokenet vises nøyaktig én gang ved opprettelse. Kun SHA-256-sammendraget lagres permanent i api_keys-lageret.
  • Nettverks- og levetidsbegrensninger: Hver nøkkel støtter en IP-tillatelsesliste (allowed_ips) og et automatisk utløpstidsstempel (expires_at).
  • Revisjonsspor og OpenAPI: Hvert API-kall registreres i revisjonsloggen (GET /api/v1/api-audit), og noden eksporterer en maskinlesbar OpenAPI-spesifikasjon (apium-cloud-os-openapi.json) for SDK-generering.

2. RBAC-omfangsmatrise og lisensnivåer

I stedet for alt-eller-ingenting-administratortokens håndhever Apium Cloud OS minste privilegiums tilgang via kommaseparerte omfang (scopes). På gratisutgaven Lite er kun read-tilgang tillatt; full og alle skriveomfang krever Pro, Ultra eller Extra.

API-nøkkelomfang og profiler med minste privilegium

Tilgangskontroll

Kombiner globale eller ressursnivå-omfang for å isolere faktureringsboter, SRE-overvåkere og HR-automatisering.

Omfang / MønsterTilgangsnivåTypisk operasjonell nøkkelprofil
fullUbegrenset lesing og skriving på tvers av alle domener (Pro/Ultra/Extra)Hovedorkestrator eller dedikert IaC-kontroller
readGlobal skrivebeskyttet tilgang på tvers av ressurser (ekskludert /system/config)Sentralisert flåteobservatør eller eksternt BI-dashbord
users:read / users:writeLes kontoer og sesjoner / opprett, forleng, tilbakekall, spark og bulk-operasjonerTelegram- og SaaS-faktureringsboter, HR/IAM-onboarding
groups:read / groups:writeInspiser brukergrupper / tildel og endre gruppepolicyerAvdelingsbasert bedriftstilgangsautomatisering
plans:read / plans:writeList opp tariffplaner / opprett/slett planer og bruk trafikk-shaperKommersiell tariffsynkronisering og båndbreddepolicymotor
webhooks:read / webhooks:writeList opp webhook-mål / registrer eller fjern HMAC-endepunkterAutomatisert hendelsesbuss-provisjonering per leietaker
monitoring:readTilgang til /overview, /health, /metrics, /sessions, /logs, /api-auditPrometheus-skrapere, Grafana, SIEM- og SOC-innsamlere
system:read / system:writeSystemstatus / kaskademodus, oppstrømmer, tjenester og sikkerhetsmodusSRE-failover-automatisering og tjenestelivssyklusskript

3. Komplett endepunktkart på tvers av 7 kontrolldomener

Alle administrative ruter ligger under /<console>/api/v1 og dekker hele den operasjonelle overflaten til noden:

Endepunkter gruppert etter funksjonelt domene

API-overflate

Hvert delsystem som administreres i web-UI-et er eksponert for deterministisk API-automatisering.

DomeneNøkkelendepunkterKapabiliteter
Brukere og bulk-livssyklusGET/POST /users, GET /users/generate, POST /users/bulk-create, POST /users/bulk-extendOpprett kontoer, batch-provisjoner flåter, og masseforleng kvoter eller TTL-er
Kontroll per brukerGET /users/:id/config, POST /users/:id/extend|revoke|restore|reset-traffic|rotate-token|kick, PUT /users/:id/group|expiration|restrictions, GET /users/:id/sessionsHent klientkonfigurasjoner, roter tokens, spark aktive sesjoner og juster grenser per bruker
Planer og shaperGET/POST /plans, DELETE /plans/:id, POST /shaper/applyAdministrer tariffmaler og skyv ut direkte båndbredde-/shaper-regler
Kaskade og oppstrømmerPUT /cascade/mode, POST /upstreams/check, POST /upstreams/:id/toggle, POST /upstreams/:id/reset-trafficBytt kaskaderutemoduser, probe utgangsnoder, slå av/på oppstrømmer, nullstill tellere
Overvåking og revisjonGET /overview, GET /health, GET /metrics, GET /sessions, POST /sessions/:id/kick, GET/DELETE /logs, POST /logs/simulate, GET /api-auditHelsesjekker, Prometheus-telemetri, avslutning av direkte sesjoner og API-revisjonslogger
Webhooks og nøklerGET/POST /webhooks, DELETE /webhooks/:id, GET/POST /api-keys, DELETE /api-keys/:idProgrammatisk livssyklus for HMAC-webhook-abonnenter og omfangsbestemte API-nøkler
Tjenester, sikkerhet og lisensPOST /services/toggle|restart|update-adblock|unban-ip|clear-auth-logs, PUT /settings/security-mode, GET /license/status, POST /license/activateDaemonkontroll, Fail2ban IP-oppheving av utestengelse, AdBlock-oppdateringer og lisensaktivering
Corporate GatewayGET /enterprise/overview, POST /enterprise/users/:id/toggle, .../enterprise/users/:id, .../enterprise/gateways/:idDedikert kontrollplan for Corporate Gateway-brukere og gatewaynoder

4. Praktiske forespørsels- og hendelseseksempler

A. Bulk brukerprovisjonering og forlengelse

Opprett kontoer bundet til en tariffplan (plan_id), kjør batch-provisjonering, eller forleng abonnementer med automatisk gjenoppretting (auto_restore: true) uten å starte transportkjerner på nytt:

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. Offentlig abonnementsendepunkt (standard klientheadere)

Klientapper som v2rayNG, Nekobox, Streisand og Hiddify henter én enkelt tokenisert URL som returnerer Base64-profiler sammen med standard kvote- og utløpsheadere:

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-signerte webhooks

I stedet for å polle noden hvert par sekunder, konfigurer faktureringsbackenden eller CRM-et til å motta push-hendelser i sanntid verifisert 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-metrikker (GET /api/v1/metrics)

Koble flåten din direkte til Prometheus og Grafana med en monitoring:read-nøkkel for å spore aktive sesjoner, antall brukere og RTT-er for oppstrøms kaskade:

# 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. Praktiske integrasjonsscenarioer

Hvor Apium Cloud OS API utmerker seg

Integrasjonsmønstre

Vanlige produksjonsarkitekturer bygget på toppen av Apium REST API, RBAC-nøkler, Webhooks og Prometheus.

ScenarioBrukte API-primitiverOperasjonell fordel
Telegram-boter og SaaS-faktureringusers:write-nøkkel + POST /users, /users/bulk-create, /extend, Subscriptions + WebhooksØyeblikkelig nøkkellevering etter betaling, automatiske fornyelser, null manuelt adminarbeid
Bedrifts HR / IAM-onboardingusers:write + groups:write + POST /users/:id/kick og /enterprise/...Automatisk VPN-tilgang ved ansettelse og øyeblikkelig sesjonstilbakekalling ved fratredelse
Flåte-SRE og overvåkingmonitoring:read-nøkkel + GET /metrics, /health, /api-audit + IP-tillatelseslisteGrafana-dashbord og varsler uten å eksponere skrivetillatelser
Kaskade- og shaper-automatiseringsystem:write + plans:write + PUT /cascade/mode, POST /upstreams/check, POST /shaper/applyDynamisk failover på tvers av utgangsland og automatisert båndbreddehåndhevelse