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?
5 redenen om API Access vandaag te integreren met READy
Ontdek de voordelen van API Access. Als u de software-oplossing integreert met READy, krijgt u nieuwe eigenschappen en functies zonder verlies van functies die u al kent van READy.
1. Automatiseer toegang tot READy-data
API Access biedt een snelle, flexibele en kosteneffectieve manier voor het automatisch integreren van READy-data van Kamstrup-meters met andere systemen ongeacht hun onderliggende architectuur. Het stelt u in staat om een digitaal ecosysteem te bouwen en gegevens te delen over verschillende platforms. API Access ondersteunt veel gebruikers en aanvragen, en door de software architectuur kan het systeem met u en uw behoeften meegroeien.
2. Verminder handmatige processen
API Access stelt software-ontwikkelaars in staat om verschillende taken en processen tussen meerdere systemen en toepassingen te automatiseren, zoals GIS of SCADA. Het kan ook helpen bij het verbeteren van bijvoorbeeld facturatieworkflows omdat computers in plaats van mensen taken uitvoeren, waardoor u efficiënte en effectieve workflows bereikt terwijl u fouten als gevolg van handmatig werk vermindert en kosten bespaart.
3. Blijf op de hoogte
Blijf up-to-date over slimme meetdata met API Access. U kunt zich abonneren op data van READy en data on-demand collecteren. Ontvang de nieuwste gegevens zodra ze beschikbaar zijn, doordat de API automatische en onmiddellijke synchronisatie tussen systemen garandeert en je op de hoogte stelt van nieuwe gegevens.
4. Houd uw data veilig
Veiligheid is een topprioriteit met API Access. Vanwege de onderliggende architectuur is een API een veiliger optie dan alternatieve methoden voor data-overdracht. API Access ondersteunt het standaard protocol voor autorisatie, OAuth2, waardoor alleen geautoriseerde gebruikers toegang hebben tot het systeem en bepaalde API-aanroepen kunnen uitvoeren.
5. Begin makkelijk met REST API
Het is gemakkelijk om aan de slag te gaan met API Access als u software-ontwikkelingsmogelijkheden in huis heeft, of samenwerkt met iemand die dit heeft, aangezien API-toegang is gebaseerd op best practices zoals REST, JSON en OAuth2 en grondig is gedocumenteerd via Swagger UI.
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.
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
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?
Heeft u nog vragen over API Access?
Lees onze FAQ
Wat is API Access? De (korte) technische uitleg
READy API Access is een RESTful Application Programming Interface (API) die gebruikt kan worden om op programmeerbare wijze apps en services te creëren en andere taken uit te voeren die voorheen alleen binnen Kamstrup's software suite konden worden uitgevoerd. API Access ondersteunt reguliere REST-verzoeken en webhooks en is alleen beschikbaar voor klanten die gehost zijn in Kamstrup's hosting omgeving (tegen meerprijs).
Heeft u voorbeelden van hoe andere bedrijven API Access gebruiken?
Verschillende nutsbedrijven gebruiken API Access voor verschillende dingen. Toch zijn er enkele belangrijke use cases die we zien:
- Het gebruik van API Access om een interne gegevensopslag te bouwen om de best mogelijke gegevensbasis te creëren
- Het gebruik van API Access om READy te integreren met het facturatiesysteem om factureringsconformiteit te waarborgen
- Het gebruik van API Access om het gebruik van tools van derden voor meterwisseling te activeren en om automatisch meterwisselingen in READy bij te werken
- Het gebruik van API Access om gegevens te integreren in consumentenportalen of -applicaties, zodat deze automatisch worden bijgewerkt met de nieuwste informatie
Wat zijn de belangrijkste voordelen van API Access?
Het gebruik van API Access heeft meerdere voordelen. De belangrijkste voordelen zijn:
- Laat READy samenwerken met andere systemen
- Automatiseer handmatige processen
- Vertrouw op de nieuwste data en alarmen
- Reflecteer wijzigingen van een systeem terug in READy
- Draag data veilig over tussen systemen
- Laat uw softwareontwikkelaars snel aan de slag gaan
Wat is het verschil tussen een REST-aanvraag en een webhook?
In standaard aanvraag-reactie REST API's, wordt data op aanvraag geleverd, waardoor ze reactief zijn. Dit betekent dat ze reageren op verzoeken, maar niets doen zonder aansturing van de gebruiker. Een webhook is daarentegen event-driven, wat betekent dat het systeem data naar een ander systeem kan sturen zodra er een bepaalde gebeurtenis plaatsvindt.
Is API Access veilig?
Ja. API Access ondersteunt gedelegeerde OAuth2-toegang, wat betekent dat alle externe service-aanroepen een geldige OAuth2-verificatietoken als Bearer Token moeten bevatten. Verificatietokens controleren of gebruikers zijn wie ze beweren te zijn en of ze toegangsrechten hebben voor de specifieke API-aanroep die ze proberen te gebruiken. Het token wordt gecreëerd gebaseerd op een huurders-ID, een klant-ID en een klantsleutel. Daarnaast moeten webhooks/abonnementen worden geverifieerd met een API-sleutel, te vinden in READy Manager. API Access maakt gebruik van HTTPS, wat betekent dat het Transport Layer Security (TLS) protocol wordt gebruikt voor het versleutelen van standaard HTTP-aanvragen en -reacties. Met API Access wordt data ook versleuteld tijdens overdracht met SSL-certificaten.
Hoe wordt vertrouwelijke data verwerkt via API Access?
Alle data verwerkt via API Access wordt op dezelfde veilige manier afgehandeld. Voor een introductie over beveiliging van data, zie het antwoord op "Is API Access veilig?" hierboven.
Hoe begin ik met API Access?
API Access is een add-on bij READy Manager, en om te beginnen moet u contact opnemen met uw Kamstrup salesmedewerker en toegang aanvragen. Om te beginnen met het bouwen van uw eigen oplossingen met API Access, raden wij u aan om onze handleiding genaamd "Get started with API Access" door te nemen en onze online documentatie te bekijken: EU & VS.
Wat zijn de voorwaarden om te starten met API Access?
Vier eenvoudige stappen moeten worden genomen om API-toegang te gaan gebruiken: (1) U moet een Kamstrup READy-hosted afnemer zijn; (2) U heeft een actief e-mailadres en telefoonnummer nodig; (3) U heeft een actieve server nodig als u webhooks wilt gebruiken; en (4) U heeft eigen software-ontwikkeling in huis, of een partnerschap met iemand die dat heeft, omdat Kamstrup geen consultancydiensten met betrekking tot API levert.
Lees verder in het datasheet genaamd "READy – API Access".
Hoe kan API Access helpen interne workflows te stroomlijnen?
API Access stelt software-ontwikkelaars in staat om verschillende taken tussen meerdere systemen en toepassingen te automatiseren. Dit kan helpen bij het verbeteren van bijvoorbeeld facturatieworkflows omdat computers in plaats van mensen taken uitvoeren waardoor u in staat bent efficiëntere en effectievere workflows te realiseren door het verminderen van handmatige fouten en het verlagen van kosten.
Kan ik mijn oplossing testen op niet-productiedata nadat ik deze heb ontwikkeld?
Kamstrup levert een product genaamd "API Access - Development Environment", dat u kunt aanschaffen om uw oplossingen te testen alvorens u deze in uw live-systeem implementeert. De belangrijkste voordelen van dit product zijn dat het u in staat stelt om uw code te schrijven en te testen zonder het risico uw productiedata te verstoren. Neem contact op met uw contactpersoon bij Kamstrup voor meer informatie.
Is de nieuwe API Access sandbox, "API Access – Development Environment", onderdeel van mijn API Access- of READy-abonnement?
Nee. De API Access sandbox is een op zichzelf staand product. Dit betekent dat het zijn eigen prijs en contractuele voorwaarden heeft. Neem contact op met uw contactpersoon bij Kamstrup om toegang aan te vragen.
Kan ik een proefperiode krijgen voor API Access voordat ik beslis of ik het wil aanschaffen?
Nee. Bij Kamstrup bieden we geen API Access proefperiodes aan. Maar als je besluit een abonnement te nemen, onthoud dan dat het abonnement altijd kan worden beëindigd.
Kan ik nieuwe functies of aankomende versies van READy API Access testen voordat ze worden geïntroduceerd?
Nee. Op dit moment is dat niet mogelijk. Functies en nieuwe versies kunnen pas worden gebruikt wanneer deze officieel zijn vrijgegeven voor alle API-klanten.
Wat gebeurt er als ik API Access bestel?
Het eerste dat gebeurt nadat u API Access heeft besteld is dat u een aanvullende overeenkomst dient te ondertekenen met informatie over de levering van API Access en wat u mag verwachten. Vervolgens zult u uw huurders-ID en klant-ID ontvangen via e-mail en uw klantsleutel via sms.
Is de klantsleutel hetzelfde als de sleutel gevonden in READy Manager?
Nee. Uw klantsleutel is een stukje informatie die u via SMS ontvangt wanneer u API-toegang bestelt. De API-sleutel in READy Manager is een unieke sleutel die wordt gebruikt voor het verifiëren van webhooks.
Moet ik een licentie activeren wanneer ik API Access heb aangeschaft, net zoals ik moest doen bij andere Kamstrup-softwareproducten?
Nee. Het enige wat u hoeft te doen is de huurders-ID, klant-ID, klantsleutel en API-sleutel gebruiken zodra u deze van ons heeft ontvangen.
Als een van de info-code-eindpunten een lijst met strings retourneert, wat kan ik dan verwachten te ontvangen?
Door contact op te nemen met Kamstrup support kunt u een lijst krijgen met mogelijke geretourneerde strings in .xml-indeling.
Naast slimme meters van Kamstrup, bevat mijn distributienet druksensoren van Kamstrup. Kan data daarvan worden overgedragen via API Access?
Ja. Als de druksensor van Kamstrup is en de metingen van de sensor als reguliere metingen in READy staan, wat standaard het geval zou moeten zijn, dan zou er geen probleem moeten zijn bij het ophalen van deze data via API Access. Als u problemen ondervindt kunt u via de servicedesk een supportticket indienen.
In de Swagger-documentatie voor API Access staan sommige eindpunten vermeld met /v1/ en andere met /v2/. Is de ene beter dan de andere?
/v1/ en /v2/ maken deel uit van onze versiebeheerstrategie. De /v2/-eindpunten kunnen worden beschouwd als een nieuwe manier om dezelfde data te verkrijgen als beschikbaar zijn via de /v1/-eindpunten. In de meeste gevallen zijn de /v2/-eindpunten echter eenvoudiger wat betreft wat er moet gebeuren in het READy-backend voor de API om de gevraagde data op te halen. Daarom kunnen beide versies worden gebruikt, maar /v2/ zal waarschijnlijk betere stabiliteit leveren.
Welke eindpunten moet ik gebruiken om mijzelf te authenticeren?
Als u ooit verschillende authenticatie-eindpunten tegenkomt, is het deze die u moet gebruiken: https://signon.kamstrup.com/token.
Wat is API Access? De (korte) technische uitleg
READy API Access is een RESTful Application Programming Interface (API) die gebruikt kan worden om op programmeerbare wijze apps en services te creëren en andere taken uit te voeren die voorheen alleen binnen Kamstrup's software suite konden worden uitgevoerd. API Access ondersteunt reguliere REST-verzoeken en webhooks en is alleen beschikbaar voor klanten die gehost zijn in Kamstrup's hosting omgeving (tegen meerprijs).
Heeft u voorbeelden van hoe andere bedrijven API Access gebruiken?
Verschillende nutsbedrijven gebruiken API Access voor verschillende dingen. Toch zijn er enkele belangrijke use cases die we zien:
- Het gebruik van API Access om een interne gegevensopslag te bouwen om de best mogelijke gegevensbasis te creëren
- Het gebruik van API Access om READy te integreren met het facturatiesysteem om factureringsconformiteit te waarborgen
- Het gebruik van API Access om het gebruik van tools van derden voor meterwisseling te activeren en om automatisch meterwisselingen in READy bij te werken
- Het gebruik van API Access om gegevens te integreren in consumentenportalen of -applicaties, zodat deze automatisch worden bijgewerkt met de nieuwste informatie
Wat zijn de belangrijkste voordelen van API Access?
Het gebruik van API Access heeft meerdere voordelen. De belangrijkste voordelen zijn:
- Laat READy samenwerken met andere systemen
- Automatiseer handmatige processen
- Vertrouw op de nieuwste data en alarmen
- Reflecteer wijzigingen van een systeem terug in READy
- Draag data veilig over tussen systemen
- Laat uw softwareontwikkelaars snel aan de slag gaan
Wat is het verschil tussen een REST-aanvraag en een webhook?
In standaard aanvraag-reactie REST API's, wordt data op aanvraag geleverd, waardoor ze reactief zijn. Dit betekent dat ze reageren op verzoeken, maar niets doen zonder aansturing van de gebruiker. Een webhook is daarentegen event-driven, wat betekent dat het systeem data naar een ander systeem kan sturen zodra er een bepaalde gebeurtenis plaatsvindt.
Is API Access veilig?
Ja. API Access ondersteunt gedelegeerde OAuth2-toegang, wat betekent dat alle externe service-aanroepen een geldige OAuth2-verificatietoken als Bearer Token moeten bevatten. Verificatietokens controleren of gebruikers zijn wie ze beweren te zijn en of ze toegangsrechten hebben voor de specifieke API-aanroep die ze proberen te gebruiken. Het token wordt gecreëerd gebaseerd op een huurders-ID, een klant-ID en een klantsleutel. Daarnaast moeten webhooks/abonnementen worden geverifieerd met een API-sleutel, te vinden in READy Manager. API Access maakt gebruik van HTTPS, wat betekent dat het Transport Layer Security (TLS) protocol wordt gebruikt voor het versleutelen van standaard HTTP-aanvragen en -reacties. Met API Access wordt data ook versleuteld tijdens overdracht met SSL-certificaten.
Hoe wordt vertrouwelijke data verwerkt via API Access?
Alle data verwerkt via API Access wordt op dezelfde veilige manier afgehandeld. Voor een introductie over beveiliging van data, zie het antwoord op "Is API Access veilig?" hierboven.
Hoe begin ik met API Access?
API Access is een add-on bij READy Manager, en om te beginnen moet u contact opnemen met uw Kamstrup salesmedewerker en toegang aanvragen. Om te beginnen met het bouwen van uw eigen oplossingen met API Access, raden wij u aan om onze handleiding genaamd "Get started with API Access" door te nemen en onze online documentatie te bekijken: EU & US.
Wat zijn de voorwaarden om te starten met API Access?
Vier eenvoudige stappen moeten worden genomen om API-toegang te gaan gebruiken: (1) U moet een Kamstrup READy-hosted afnemer zijn; (2) U heeft een actief e-mailadres en telefoonnummer nodig; (3) U heeft een actieve server nodig als u webhooks wilt gebruiken; en (4) U heeft eigen software-ontwikkeling in huis, of een partnerschap met iemand die dat heeft, omdat Kamstrup geen consultancydiensten met betrekking tot API levert.
Lees verder in het datasheet genaamd “READy – API Access”.
Hoe kan API Access helpen interne workflows te stroomlijnen?
API Access stelt software-ontwikkelaars in staat om verschillende taken tussen meerdere systemen en toepassingen te automatiseren. Dit kan helpen bij het verbeteren van bijvoorbeeld facturatieworkflows omdat computers in plaats van mensen taken uitvoeren waardoor u in staat bent efficiëntere en effectievere workflows te realiseren door het verminderen van handmatige fouten en het verlagen van kosten.
Kan ik mijn oplossing testen op niet-productiedata nadat ik deze heb ontwikkeld?
Kamstrup levert een product genaamd "API Access - Development Environment", dat u kunt aanschaffen om uw oplossingen te testen alvorens u deze in uw live-systeem implementeert. De belangrijkste voordelen van dit product zijn dat het u in staat stelt om uw code te schrijven en te testen zonder het risico uw productiedata te verstoren. Neem contact op met uw contactpersoon bij Kamstrup voor meer informatie.
Is de nieuwe API Access sandbox, "API Access – Development Environment", onderdeel van mijn API Access- of READy-abonnement?
Nee. De API Access sandbox is een op zichzelf staand product. Dit betekent dat het zijn eigen prijs en contractuele voorwaarden heeft. Neem contact op met uw contactpersoon bij Kamstrup om toegang aan te vragen.
Kan ik een proefperiode krijgen voor API Access voordat ik beslis of ik het wil aanschaffen?
Nee. Bij Kamstrup bieden we geen API Access proefperiodes aan. Maar als je besluit een abonnement te nemen, onthoud dan dat het abonnement altijd kan worden beëindigd.
Kan ik nieuwe functies of aankomende versies van READy API Access testen voordat ze worden geïntroduceerd?
Nee. Op dit moment is dat niet mogelijk. Functies en nieuwe versies kunnen pas worden gebruikt wanneer deze officieel zijn vrijgegeven voor alle API-klanten.
Wat gebeurt er als ik API Access bestel?
Is de klantsleutel hetzelfde als de sleutel gevonden in READy Manager?
Nee. Uw klantsleutel is een stukje informatie die u via SMS ontvangt wanneer u API-toegang bestelt. De API-sleutel in READy Manager is een unieke sleutel die wordt gebruikt voor het verifiëren van webhooks.
Moet ik een licentie activeren wanneer ik API Access heb aangeschaft, net zoals ik moest doen bij andere Kamstrup-softwareproducten?
Nee. Het enige wat u hoeft te doen is de huurders-ID, klant-ID, klantsleutel en API-sleutel gebruiken zodra u deze van ons heeft ontvangen.
Als een van de info-code-eindpunten een lijst met strings retourneert, wat kan ik dan verwachten te ontvangen?
Door contact op te nemen met Kamstrup support kunt u een lijst krijgen met mogelijke geretourneerde strings in .xml-indeling.
Naast slimme meters van Kamstrup, bevat mijn distributienet druksensoren van Kamstrup. Kan data daarvan worden overgedragen via API Access?
Ja. Als de druksensor van Kamstrup is en de metingen van de sensor als reguliere metingen in READy staan, wat standaard het geval zou moeten zijn, dan zou er geen probleem moeten zijn bij het ophalen van deze data via API Access. Als u problemen ondervindt kunt u via de servicedesk een supportticket indienen.
In de Swagger-documentatie voor API Access staan sommige eindpunten vermeld met /v1/ en andere met /v2/. Is de ene beter dan de andere?
/v1/ en /v2/ maken deel uit van onze versiebeheerstrategie. De /v2/-eindpunten kunnen worden beschouwd als een nieuwe manier om dezelfde data te verkrijgen als beschikbaar zijn via de /v1/-eindpunten. In de meeste gevallen zijn de /v2/-eindpunten echter eenvoudiger wat betreft wat er moet gebeuren in het READy-backend voor de API om de gevraagde data op te halen. Daarom kunnen beide versies worden gebruikt, maar /v2/ zal waarschijnlijk betere stabiliteit leveren.
Welke eindpunten moet ik gebruiken om mijzelf te authenticeren?
Als u ooit verschillende authenticatie-eindpunten tegenkomt, is het deze die u moet gebruiken:
https://signon.kamstrup.com/token.
Laten we het gesprek aangaan
Hoe kunnen wij u vandaag helpen?