Avensor API
Avensor Application Programming Interface (API) gir de eksterne systemene tilgang til Avensor-dataene. Følgende informasjon er tilgjengelig via API-ene:
- Alarmdata
- Sanntidsdata
- Stasjonsdata
- Enhetsdata
- Kunde Data
- Brukerdata
Avensor APIene brukes kun til å motta dataene. Brukeren kan ikke kontrollere enhetene eller redigere data gjennom Avensor API-ene ved å legge til en ekstern klient.
Legge til en ekstern klient
- Logg inn påAvensor.
- Gå tilAdmin > Kunder.
- Velg en kunde.
- Gå tilfanenEksterne klienter.
- Klikk påLegg til-knappen.
- Angi et navn.
- Angi enbeskrivelse.
Det er valgfritt å skrive en beskrivelse. - Klikk Lagre.
En ekstern klient opprettes og brukeren får en unikAuth0-klient-IDog en engangsAuth0-klienthemmelighet.Det er viktig å lagre klienthemmeligheten siden den bare vises én gang. Klienthemmeligheten kreves for å få tilgang tilAvensorREST API-ene. Hvis brukeren glemmer klientens hemmelighet, må det opprettes en ny ekstern klient.
API-dokumentasjon
Avensor API-dokumentasjonen er tilgjengelig i Avensor-applikasjonen. Slik får du tilgang til Avensor API-dokumentasjon:
- Logg inn på Avensor-applikasjonen.
- Klikk på profilikonet øverst til høyre.
- Klikk på Eksterne klientressurser .
- Klikk påAPI-koblingen for å laste ned Avensor API YAML-filen.
Den nedlastede filen inneholder følgende informasjon.
- REST API-baner
- Forespørselsformat
- Svarformat
- Skjemainformasjon
Hvis du vil ha mer informasjon om Avensor-autentiseringsmekanismen og hvordan du ringer til Avensor API-ene, klikker du påkoblingenInstallasjonsveiledning på eksterne klientressurser. Den nedlastede filen inneholder følgende informasjon:
- Sette opp en ekstern klient
- Hente JWT-tokenet for autentisering