INEXTIA Application Programming Interface

INEXTIA API giver mulighed for at andre systemer kan hente og sende data fra og til INEXTIA.
Dvs. hvis der skal være et interface til eksempelvis ERP, SCADA / SRO eller GIS, så vil det være API’et der benyttes.

Når man kommunikerer med API’et, så er alle forespørgsler forbundet med en bruger.
Det betyder at man også kun har adgang til de data, som den bruger har adgang til.

Generelt

API’et er designet omkring principperne i REST http services.

Der bruges HTTP requests til kommunikation med API'et. Request / response data er i JSON format.

Som udgangspunkt gælder:

• GET http requests.
  Kan hente data. GET requests må ikke rette i data.
• POST http requests.
  Opretter data. I tilfælde hvor ”handlinger” skal bruge data input, f.eks ved søgning, login m.m. bruges også POST, da GET ikke kan sende data input med.
• PUT http requests.
  Bruges til at rette eksisterende objekter.
• DELETE http requests.
  Bruges til at slette objekter.

Swagger / dokumentation

Der er tilgængelig dokumentation i selve API’et omkring objekt strukturerer, endpoints og hvilke http metoder der skal bruges til de forskellige forespørgsler.
Dokumentationen vises ved at sætte ”api/swagger” efter adressen til INEXTIA sitet.

https://<sitename>.inextia.dk/api/swagger

Fra værktøjet swagger er der også mulighed for at teste de forskellige forespørgsler og se hvilke svar der kommer tilbage.

Forespørgslen afprøves ved at udfylde den nødvendige information og trykke på Execute. 

Token

For at kalde de forskellige endpoints kræves en token som identificerer den enkelte bruger.
Denne token modtager man ved at kalde Auth med brugernavn og adgangskode.
Token kan genbruges til den udløber. Standard er efter 24 timer.

Paging

Når der returneres en liste fra et endpoint, så er listen som udgangspunkt ”paged”.
Dvs. man får et udpluk af listen der svarer til den pageSize man bruger.
Standard er sat til 25.

Se de følgende artikler for eksempler på brug af API'et.