API Doc

Kom i gang med Dataforge

Dataforge samler måledata fra produksjonen, normaliserer dem og gjør dem tilgjengelige som sanntidsverdier, historikk og ferdige nøkkeltall. API-et gir tilgang til det samme datagrunnlaget som visningene i portalen bruker — 192 endepunkter over 32 moduler.

Hurtigstart

1. 1

   Bekreft base-URL

   Alle stier i referansen begynner med /routes. Base-URL er {API_HOST}{API_PATH} og settes som byggtidskonstant av hostingen — den kan ikke leses fra kildekoden. Slå opp faktisk domene i Deployment-innstillingene og sett den som miljøvariabel i integrasjonen.

   bash

   export DATAFORGE_BASE_URL="https://<ditt-domene>/api"
   export DATAFORGE_API_KEY="sk_live_..."

2. 2

   Hent tenant-API-nøkkelen

   Nøkkelen er én per tenant, har formatet sk_live_<64 hex tegn> og lagres SHA-256-hashet. Den krever rollen customer_admin: hent den med GET /routes/api-keys/me, og forny med POST /routes/api-keys/regenerate. Nøkkelen vises kun ved generering — lagre den i et hemmelighetshvelv.

   bash

   curl "$DATAFORGE_BASE_URL/routes/api-keys/me" \
     -H "Cookie: <plattformsesjon>"

3. 3

   Verifiser med første kall

   Eksport-endepunktene under /v1 autentiseres med X-API-Key og er scopet til tenanten din. Bruk dem til å bekrefte at nøkkel og nettverksflyt virker før du bygger videre.

   bash

   curl "$DATAFORGE_BASE_URL/routes/v1/sensors" \
     -H "X-API-Key: $DATAFORGE_API_KEY" \
     -H "Accept: application/json"

4. 4

   Bruk plattformsesjon for resten

   De øvrige modulene (assets, signaler, produksjon, KPI, brukere) krever innlogget plattformsesjon eller workspace-nøkkel — ikke tenant-API-nøkkelen. I dag er altså ekstern systemtilgang via X-API-Key begrenset til /v1-eksporten og strøminntaket.

Base-URL

Selve domenet settes ved bygg og kan ikke leses ut av koden — bekreft det i Deployment-innstillingene.

Mønster: {API_HOST}{API_PATH}/routes

Autentisering

Dataforge har tre uavhengige autentiseringslag. Det finnes ingen OAuth-scopes — tilgang styres av sesjon, tenantnøkkel eller delt webhook-hemmelighet.

GET /routes/v1/sensors HTTP/1.1
Host: <din base-URL>
X-API-Key: sk_live_<64 hex tegn>
Accept: application/json

De tre lagene