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 medcrypto.getRandomValues. Serveren kombinerer denne nyttelasten med to 32-tegns CSPRNG-strenger og et nanosekund-tidsstempel via SHA-256, og produserer etapm_<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 iapi_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
TilgangskontrollKombiner globale eller ressursnivå-omfang for å isolere faktureringsboter, SRE-overvåkere og HR-automatisering.
| Omfang / Mønster | Tilgangsnivå | Typisk operasjonell nøkkelprofil |
|---|---|---|
| full | Ubegrenset lesing og skriving på tvers av alle domener (Pro/Ultra/Extra) | Hovedorkestrator eller dedikert IaC-kontroller |
| read | Global skrivebeskyttet tilgang på tvers av ressurser (ekskludert /system/config) | Sentralisert flåteobservatør eller eksternt BI-dashbord |
| users:read / users:write | Les kontoer og sesjoner / opprett, forleng, tilbakekall, spark og bulk-operasjoner | Telegram- og SaaS-faktureringsboter, HR/IAM-onboarding |
| groups:read / groups:write | Inspiser brukergrupper / tildel og endre gruppepolicyer | Avdelingsbasert bedriftstilgangsautomatisering |
| plans:read / plans:write | List opp tariffplaner / opprett/slett planer og bruk trafikk-shaper | Kommersiell tariffsynkronisering og båndbreddepolicymotor |
| webhooks:read / webhooks:write | List opp webhook-mål / registrer eller fjern HMAC-endepunkter | Automatisert hendelsesbuss-provisjonering per leietaker |
| monitoring:read | Tilgang til /overview, /health, /metrics, /sessions, /logs, /api-audit | Prometheus-skrapere, Grafana, SIEM- og SOC-innsamlere |
| system:read / system:write | Systemstatus / kaskademodus, oppstrømmer, tjenester og sikkerhetsmodus | SRE-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-overflateHvert delsystem som administreres i web-UI-et er eksponert for deterministisk API-automatisering.
| Domene | Nøkkelendepunkter | Kapabiliteter |
|---|---|---|
| Brukere og bulk-livssyklus | GET/POST /users, GET /users/generate, POST /users/bulk-create, POST /users/bulk-extend | Opprett kontoer, batch-provisjoner flåter, og masseforleng kvoter eller TTL-er |
| Kontroll per bruker | GET /users/:id/config, POST /users/:id/extend|revoke|restore|reset-traffic|rotate-token|kick, PUT /users/:id/group|expiration|restrictions, GET /users/:id/sessions | Hent klientkonfigurasjoner, roter tokens, spark aktive sesjoner og juster grenser per bruker |
| Planer og shaper | GET/POST /plans, DELETE /plans/:id, POST /shaper/apply | Administrer tariffmaler og skyv ut direkte båndbredde-/shaper-regler |
| Kaskade og oppstrømmer | PUT /cascade/mode, POST /upstreams/check, POST /upstreams/:id/toggle, POST /upstreams/:id/reset-traffic | Bytt kaskaderutemoduser, probe utgangsnoder, slå av/på oppstrømmer, nullstill tellere |
| Overvåking og revisjon | GET /overview, GET /health, GET /metrics, GET /sessions, POST /sessions/:id/kick, GET/DELETE /logs, POST /logs/simulate, GET /api-audit | Helsesjekker, Prometheus-telemetri, avslutning av direkte sesjoner og API-revisjonslogger |
| Webhooks og nøkler | GET/POST /webhooks, DELETE /webhooks/:id, GET/POST /api-keys, DELETE /api-keys/:id | Programmatisk livssyklus for HMAC-webhook-abonnenter og omfangsbestemte API-nøkler |
| Tjenester, sikkerhet og lisens | POST /services/toggle|restart|update-adblock|unban-ip|clear-auth-logs, PUT /settings/security-mode, GET /license/status, POST /license/activate | Daemonkontroll, Fail2ban IP-oppheving av utestengelse, AdBlock-oppdateringer og lisensaktivering |
| Corporate Gateway | GET /enterprise/overview, POST /enterprise/users/:id/toggle, .../enterprise/users/:id, .../enterprise/gateways/:id | Dedikert 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/extendB. 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=1798761600C. 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"} 185. Praktiske integrasjonsscenarioer
Hvor Apium Cloud OS API utmerker seg
IntegrasjonsmønstreVanlige produksjonsarkitekturer bygget på toppen av Apium REST API, RBAC-nøkler, Webhooks og Prometheus.
| Scenario | Brukte API-primitiver | Operasjonell fordel |
|---|---|---|
| Telegram-boter og SaaS-fakturering | users:write-nøkkel + POST /users, /users/bulk-create, /extend, Subscriptions + Webhooks | Øyeblikkelig nøkkellevering etter betaling, automatiske fornyelser, null manuelt adminarbeid |
| Bedrifts HR / IAM-onboarding | users:write + groups:write + POST /users/:id/kick og /enterprise/... | Automatisk VPN-tilgang ved ansettelse og øyeblikkelig sesjonstilbakekalling ved fratredelse |
| Flåte-SRE og overvåking | monitoring:read-nøkkel + GET /metrics, /health, /api-audit + IP-tillatelsesliste | Grafana-dashbord og varsler uten å eksponere skrivetillatelser |
| Kaskade- og shaper-automatisering | system:write + plans:write + PUT /cascade/mode, POST /upstreams/check, POST /shaper/apply | Dynamisk failover på tvers av utgangsland og automatisert båndbreddehåndhevelse |