Offentligt API

Læs et projekts data programmatisk — godkendelse med adgangsnøgler, basis-URL, formater og konventioner.

Det offentlige API lader andre systemer læse et projekts data via HTTP, f.eks. til dashboards, rapporter, fakturering eller analyser uden for THMI. Det giver adgang til de samme data, som du ser i Cloud (tags, deres værdier, historik og sider), som et almindeligt REST-API.

Godkendelse

Hver anmodning godkendes med en adgangsnøgle. Opret en nøgle, vælg, hvilke projekter og ressourcer den må læse, og send den derefter som et bearer-token:

Authorization: Bearer <your-token>

En nøgle når kun de projekter og ressourcetyper, den har fået adgang til, så du kan uddele snævert afgrænset adgang: præcis de data, et bestemt system har brug for, og intet mere. API’et er skrivebeskyttet.

Basis-URL og versionering

API’et findes under /api/v1 på din Cloud-vært, og de fleste stier er afgrænset til et projekt:

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

v1 i stien er API-versionen. Se Endpoints for den fulde liste.

Formater

• Svar er som standard JSON. Nogle endpoints returnerer også CSV (til eksport og historik) eller SVG (til sider). Formatet er en del af stien, hvor det er relevant.
• Endpoints til historik og CSV-eksport bruger POST med en JSON-body til at bære forespørgslen (tidsinterval, tags, gruppering); alt andet er GET. Begge er læseoperationer.

OpenAPI-specifikationen

API’et udgiver sin egen OpenAPI-specifikation, den autoritative og altid opdaterede definition af hvert endpoint, 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

Peg din API-klient eller kodegenerator på den i stedet for at kopiere stier i hånden.