API Access voor het naadloos delen van READy-data met andere systemen

Wat is API Access?

Kamstrup API Access biedt een veilige manier om data van READy te delen met andere systemen, zoals klantportalen, GIS, of SCADA. Dit maakt het mogelijk om een digitaal ecosysteem te creëren waar informatie van verschillende systemen wordt gedeeld, waardoor u uw klantenservice kunt verbeteren en operations en bestaande workflows kunt optimaliseren.

API Access is een add-on voor READy voor gebruikers die gegevens makkelijk en veilig tussen hun systemen willen overdragen. API Access is beschikbaar voor bestaande READy-klanten die door Kamstrup worden gehost. Het kan niet worden aangeboden aan lokale READy-installaties. U blijft beschikken over de eigenschappen in READy die u al kent, terwijl API Access een meer gestroomlijnde informatievoorziening en een geïntegreerde gebruikerservaring creëert tijdens uw gebruik van READy.

Kamstrup biedt een veilige manier voor nutsbedrijven en externe ontwikkelaars om aanvragen via API Access te ontwikkelen en te testen door het beschikbaar stellen van een testomgeving die we een 'sandbox' noemen. Met deze optie is het mogelijk om de integratie en toepassing robuust te maken voordat deze in productie wordt genomen.

Wat is een API?

Een Application Programming Interface (API) is code die fungeert als brug tussen verschillende systemen - vaak van verschillende leveranciers - waardoor twee of meer systemen kunnen communiceren en gegevens kunnen delen, ongeacht hun onderliggende architecturen of technologieën.

API Access vergelijken met de READy exportfunctie. Wat is het verschil?

Hieronder geven we de belangrijkste verschillen aan zodat u de functies van API Access kunt vergelijken met de READy exportfunctie. Wanneer u Kamstrup API Access integreert, behoudt u de READy exportfunctie - u voegt gewoon meer opties toe en maakt een efficiëntere overdracht van gegevens mogelijk, evenals meer controle bij het werken met metergegevens.

READy exportfunctie

READy API Access

Data-export op basis van regels

Met de exportfunctie ingebouwd in READy Manager, moet u aangeven of uw data elk uur, dagelijks, wekelijks of maandelijks moeten worden geëxporteerd. De export vindt vervolgens plaats volgens een vast exportschema, waarbij de laagste frequentie-instelling ieder uur is.

Data-export op basis van een gebeurtenis

Met de API Access add-on voor READy Manager kunt u gegevens automatisch laten overzetten wanneer bepaalde gebeurtenissen zich voordoen of wanneer de gegevens gereed zijn in READy, in plaats van u te houden aan een vast exportschema.

Uitgestelde alarmen

Hoewel alarmen (informatiecodes) kort na het activeren in de fysieke meter aanwezig zullen zijn in READy, dient u READy handmatig te controleren om op de hoogte te worden gesteld van de alarmen of u moet wachten tot de export van de alarmen plaatsvindt, wat pas gebeurt met de eerstvolgende geplande export.

Tijdige alarmen

U kunt zich abonneren op alarmen (informatiecodes) als API Access is geïntegreerd in READy Manager. Dit betekent dat zodra er een alarm is in READy, u een melding ontvangt en de informatie beschikbaar zal zijn via API Access.

Data-export in één richting

De READy exportfunctie dient maar één doel: data uit READy halen en beschikbaar maken buiten READy Manager. Het importeren van informatie in READy met de READy exportfunctie is niet mogelijk.

Datasynchronisatie in twee richtingen

API Access zorgt ervoor dat gegevens van READy naar andere systemen worden overgezet, maar het stelt ook andere systemen in staat om wijzigingen in groepen, installatiepunten en meters terug te sturen naar READy.

Standaard databeveiliging

Data die worden geëxporteerd via de ingebouwde exportfunctie in READy Manager worden geëxporteerd naar een SFTP-server, FTP-server of e-mail. Deze bestemmingen hebben gemeen dat ze meestal worden beveiligd met een gebruikersnaam en wachtwoord.

Geavanceerde databeveiliging

Om data via API Access over te dragen, heeft u een geldig OAuth2 toegangs-token nodig waarvoor drie dingen noodzakelijk zijn: Een klant-ID, een huurders-ID en een klantsleutel. Daarnaast is data versleuteld, en als u de webhooks/abonnementsfunctie van API Access gebruikt, is er ook een actieve API-sleutel van READy Manager nodig.

API Access voor ontwikkelaars: Hoe werkt API Access?

Kamstrup API Access is code dat de toegangspunten voor de READy server beheert. Het werkt op twee manieren: Als een standaard REST (Representational State Transfer) API, wat een webservice is die een client in staat stelt om middels URL-paden aanvragen te doen voor bronnen van READy, gebruikmakend van het Hypertext Transfer Protocol (HTTP). Dit is vergelijkbaar met wanneer je een reguliere webpagina bezoekt waarbij je een bron opvraagt die is opgeslagen op een server en de server reageert met de gevraagde informatie.

Klik op 'Lees verder' hieronder om meer te lezen over API Access.

Lees verder

Sluiten

Naast de reguliere request-response manier van werken kan Kamstrup API Access ook werken als een webhook API. Bij standaard REST API's wordt data geleverd op verzoek, waardoor ze reactief zijn. Dit betekent dat ze reageren op verzoeken, maar meestal niets doen zonder aanwijzingen van de gebruiker. Aan de andere kant kan een webhook verzoeken (zoals aanvragen om alle meters op te halen) en gebeurtenissen (zoals abonneren op de laatste meteruitlezingen) afhandelen. Event-driven betekent dat het één systeem in staat stelt om gegevens naar een ander systeem te sturen zodra een bepaalde gebeurtenis plaatsvindt. Zowel webhook als REST API reageren in JSON.

Vanuit technisch oogpunt stelt API Access ontwikkelaars in staat om data van apparaten zoals meters te automatiseren, uit te breiden en combineren met andere systemen of diensten, waarbij de veiligheid is gewaarborgd. In de praktijk zijn ontwikkelaars hierdoor in staat om een digitaal ecosysteem te creëren, programmatisch apps en services te ontwikkelen en andere taken uit te voeren die voorheen alleen mogelijk waren binnen de software suite van Kamstrup.

Om READy automatisch te integreren in uw IT-systeem, moet u beschikken over eigen software-ontwikkeling omdat dit geen deel uitmaakt van het aanbod van API Access.

Kamstrup biedt ook het product “API Access – Development Environment”, een API sandbox waarin testen kunnen worden uitgevoerd. Met de sandbox kunnen programmeurs en ontwikkelaars wijzigingen uitproberen zonder iets te veranderen in de live omgeving. Dit geeft ook de mogelijkheid aan externe ontwikkelaars om oplossingen en services te ontwikkelen. De API sandbox levert testdata van circa 5.000 meters om ontwikkelaars in staat te stellen om nieuwe code te testen, real-life omstandigheden na te bootsen en gesimuleerde reacties te creëren. Het is een apart product van API Access en is beschikbaar voor nutsbedrijven en externe ontwikkelaars. Potentiële fouten zullen nog voor de implementatie worden ontdekt, wat de kosten en risico's in verband met nieuwe reacties vermindert.

Bent u klaar om te beginnen met API Access voor toegang tot data van READy en heeft u de software al aangeschaft?