Offentlig API

Les et prosjekts data programmatisk — autentisering med tilgangstokener, basis-URL, formater og konvensjoner.

Med det offentlige API-et kan andre systemer lese et prosjekts data over HTTP — for å forsyne dashbord, rapporter, fakturering eller analyse utenfor THMI. Det eksponerer de samme dataene du ser i Cloud (tagger, verdiene deres, historikk og sider) som et vanlig REST-API.

Autentisering

Hver forespørsel autentiseres med et tilgangstoken. Opprett et token, velg hvilke prosjekter og ressurser det kan lese, og send det deretter som et bearer-token:

Authorization: Bearer <your-token>

Et token når bare prosjektene og ressurstypene det har fått tilgang til, så du kan dele ut snevert avgrenset tilgang — nøyaktig de dataene et bestemt system trenger, og ikke mer. API-et er skrivebeskyttet.

Basis-URL og versjonering

API-et leveres under /api/v1 på Cloud-verten din, og de fleste baner gjelder ett bestemt prosjekt:

https://<your-cloud-host>/api/v1/{projectId}/...

v1 i banen er API-versjonen. Se Endepunkter for hele listen.

Formater

  • Svarene er i JSON som standard; noen endepunkter returnerer også CSV (for eksport og historikk) eller SVG (for sider) — formatet er en del av banen der det er aktuelt.
  • Endepunktene for historikk og CSV-eksport bruker POST med en JSON-kropp for å sende spørringen (tidsrom, tagger, gruppering); alt annet er GET. Begge er leseoperasjoner.

OpenAPI-spesifikasjonen

API-et publiserer sin egen OpenAPI-spesifikasjon — den autoritative og alltid oppdaterte definisjonen av hvert endepunkt, hver parameter og hvert svar. Hent den som JSON eller YAML:

https://<your-cloud-host>/api/openapi.json
https://<your-cloud-host>/api/openapi.yaml

Pek API-klienten eller kodegeneratoren din mot den i stedet for å kopiere baner for hånd.