API Access – sömlös delning av READy-data med andra system

Vad är API Access?

Kamstrup API Access erbjuder ett säkert sätt för READy att dela data med andra system såsom kundportaler, GIS eller SCADA. Detta gör att man kan skapa ett digitalt ekosystem där information från olika system delas, vilket gör att du kan förbättra din kundservice, optimera driften och befintliga arbetsflöden.

API Access är ett tillägg till READy för de som vill överföra data på ett enkelt och säkert sätt mellan olika system. API Access finns tillgängligt för befintliga READy-kunder som hostas av Kamstrup. API Access erbjuds inte för lokala READy-installationer. Du kommer att ha kvar alla välkända funktioner i READy, samtidigt som API Access skapar en mer sömlös leverans av information och en integrerad användarupplevelse när du använder READy.

Kamstrup tillhandahåller ett säkert sätt för vatten och energibolag och tredjepartsutvecklare att utveckla och testa begäranden via API Access och detta genom att erbjuda en testmiljö som vi kallar en "sandlåda". Med detta alternativ är det möjligt att testa integrationen och applikationen ordentligtinnan den tas in i produktionen.

Vad är en API?

Ett applikationsprogrammeringsgränssnitt (eller API) är en kod som fungerar som en brygga mellan olika system – ofta från olika leverantörer, vilket gör att två eller flera system kan kommunicera med varandra och dela data oavsett deras underliggande arkitektur eller teknologi.

API Access kontra READy-exportfunktionen. Vad är skillnaden?

I följande exempel har vi lyft fram viktiga skillnader så att du kan jämföra funktionerna i API Access med READy-exportfunktionen. När du integrerar Kamstrup API Access kommer du att ha kvar READy-exportfunktionen – du lägger bara till fler alternativ, möjliggör effektivare överföring av data och får större kontroll när du arbetar med mätdata.

READy-exportfunktion

READy API Access

Dataexport baserad på regler

Med den inbyggda exportfunktionen i READy Manager är du tvungen att ange om dina data ska exporteras varje timme, dagligen, veckovis eller månadsvis. Exporten kommer att utföras med ett fast exportschema, med lägsta frekvensinställning per timme.

Händelsebaserad dataexport

Med API Access-tillägget till READy Manager kan du istället för att följa ett fast exportschema, välja att överföra data automatiskt när vissa händelser inträffar eller när data är klara i READy.

Fördröjda larm

Även om larm (infokoder) kommer att finnas i READy kort efter att de utlösts i den fysiska mätaren, kommer du inte att få vetskap om dem såvida du inte kontrollerar READy manuellt eller väntar på larmexporten, vilket inte kommer att ske förrän nästa inplanerade export.

Larm i tid

Du kan prenumerera på larm (infokoder) när API Access har integrerats i READy Manager. Det innebär att du får ett meddelande så fort det finns ett larm i READy. Dessutom kommer informationen att vara tillgänglig via API Access.

Envägs-dataexport

READy-exportfunktionen har bara ett syfte: att extrahera data från READy och göra den tillgänglig utanför READy Manager. Det är inte möjligt att importera information till READy med READy-exportfunktionen.

Tvåvägs-datasynkronisering

API Access överför data från READy till andra system och lösningen låter dessutom andra system skicka tillbaka ändringar i grupper, installationspunkter och mätare till READy.

Standardmässigt dataskydd

Data som exporteras via den inbyggda exportfunktionen i READy Manager exporteras till en SFTP-server, FTP-server eller e-post. Gemensamt för dessa är att de vanligtvis är skyddade av ett användarnamn och ett lösenord.

Avancerat dataskydd

För att överföra data via API Access behöver du en giltig OAuth2-åtkomsttoken som kräver tre inmatningar: Ett klient-ID, ett tenant-ID och en klienthemlighet. Dessutom är data krypterade och om du använder webhooks/prenumerationsfunktionen i API Access behöver du även en aktiv API-nyckel från READy Manager.

API Access för utvecklare: Hur fungerar API Access?

Kamstrup API Access är en kod som styr åtkomstpunkterna för READy-servern. Den fungerar på två sätt: Som en standardmässig REST (Representational State Transfer) API, vilket är en webbtjänst som gör det möjligt för en klient att göra begäranden om resurser från READy via URL-sökvägar, med hjälp av Hypertext Transfer Protocol (HTTP). Detta fungerar ungefär som när du besöker en vanlig webbsida och begär en resurs som finns lagrad på en server och servern svarar med den begärda informationen.

Klicka på Ta reda på mer nedan för att läsa mer om API Access.

Ta reda på mer

Stäng

Förutom det vanliga arbetssättet med begäran och svar, kan Kamstrup API Access även fungera som ett webhook-API. Med standardmässiga REST API:er serveras data på begäran, vilket gör dem reaktiva, vilket i sin tur innebär att de reagerar på en begäran men vanligtvis inte gör något på egen hand såvida användaren inte uppmanar till detta. Å andra sidan kan en webhook hantera begäranden (t.ex. en begäran om att hämta alla mätare) och händelser (t.ex. att prenumerera på de senaste mätaravläsningarna). Att en webhook är händelsestyrd innebär att den låter ett system skicka data till ett annat system så snart en given händelse äger rum. Både webhook och REST API svarar i JSON.

Ur teknisk synvinkel gör API Access det möjligt för utvecklare att automatisera, utöka och kombinera data från enheter såsom mätare med andra system eller tjänster samtidigt som data hålls säkra. I praktiken gör detta det möjligt för utvecklare att skapa ett digitalt ekosystem, att programmässigt utveckla appar och tjänster och utföra andra uppgifter som tidigare bara kunde utföras inom Kamstrups programvarusvit.

För att automatiskt integrera READy med ditt valda IT-system, måste du ha tillgång till programvaruutveckling, eftersom detta inte ingår i erbjudandet med API Access.

Kamstrup erbjuder också produkten “API Access – Development Environment”, en API-sandlåda där det är möjligt att utföra tester. Sandlådan gör det möjligt för programmerare och utvecklare att testa ändringar utan att ändra något i live-miljön. Den tillåter också tredjepartsutvecklare att skapa lösningar och tjänster. API-sandlådan tillhandahåller testdata från cirka 5000 mätare, vilket gör det möjligt för utvecklare att testa ny kod, härma verkliga händelser och skapa simulerade svar. Det är en separat produkt från API Access och är tillgänglig för vattrn- och energibolag samt tredjepartsutvecklare. Med denna har man möjlighet att upptäcka potentiella buggar innan implementeringen. Detta minskar både kostnader och risker.

Har du redan köpt programvaran och är redo att börja använda API Access för att få åtkomst till data i READy?