Verbind externe toepassingen met metingen, sites, rapporten en onderhoud.
De externe API biedt toegangsrechten met beperkte scope tot metingen, sites, rapporten en onderhoudsactiviteiten. Het basispad is https://unify.eniris.com/bff/ext/v1.
Gebruik de live OpenAPI-specificatie voor requestbody's, parameters en antwoordindelingen.
Verstuur een API-sleutel als Authorization: Bearer <key> of in de header x-api-keyDe toegang is afhankelijk van het account van de sleutel, de toegestane sites, de mogelijkheden en de huidige rechten van de eigenaar.
| Mogelijkheid | Doel |
|---|---|
| telemetrie | Metingen, meters, assets en KPI's lezen |
| sites:write | Sites aanmaken |
| rapporten | Rapporten en gegenereerde resultaten lezen |
| reports:write | Rapporten aanmaken of wijzigen en het genereren ervan aanvragen; vereist reports |
| operations | Onderhouds- en operationele informatie lezen |
| operations:write | Operationele gegevens wijzigen en operationele berekeningen uitvoeren; vereist operations |
GET /buildings, vervolgens GET /buildings/{id}/meters en GET /series voor metingen.GET /sites/{id}/assets, /kpis of /messages voor context over apparatuur./reports en de routes voor generatie, uitvoeringen en PDF's om rapportage te automatiseren./work-orders, /incidents en /sites/{id}/operations voor operationele opvolging.Series-aanvragen accepteren begin- en eindtijden, een aggregatiebucket en maximaal 20 meters, met een maximale periode van drie jaar. Gebruik de geretourneerde eenheden en maak onderscheid tussen ontbrekende waarden en nul.
Lees het huidige object voordat u een versie-update uitvoert. Sitebewerkingen vereisen de huidige revisie; opdrachten voor werkorders vereisen de huidige versie. Lees bij een conflict het object opnieuw en stem de beoogde wijziging daarop af.
Een 401 geeft aan dat een sleutel ongeldig is; een 403 geeft aan dat de toegang onvoldoende is. Bij een 503 moet de eigenaar van de sleutel zich mogelijk opnieuw aanmelden en het account selecteren. Meet-routes zijn alleen-lezen: toegang tot telemetrie geeft geen apparaatbesturing.