API-tilgang for enkel deling av data fra READy med andre
Hva er API Access?
Kamstrups API Access gir deg en sikker utveksling av data mellom READy og andre systemer, som kundeportaler, GIS eller SCADA. Dermed kan du skape et digitalt økosystem der informasjonen fra de forskjellige systemene er delt, slik at du får bedre kundeservice, optimalisert drift og forbedring av eksisterende arbeidsflyt.
API Access er et tilleggsmodul i READy for de som ønsker en enklere overføring av data på en sikker måte mellom sine systemer. API Access er tilgjengelig for eksisterende READy-kunder som hoster løsningen hos Kamstrup. Den er ikke tilgjengelig for lokale installasjoner av READy. Du vil fortsatt ha alle de funksjonene i READy som du allerede kjenner, mens API Access gir deg en mer fleksibel levering av informasjon, og en integrert brukeropplevelse når du bruker READy.
Kamstrup tilbyr en sikker løsning der forsyningsleverandører og tredjepartsutviklere kan utvikle og teste forespørsler via API Access i et testmiljø, også kalt en «sandbox» eller sandkasse på norsk. Med dette alternativet er det mulig å sikre at integrasjonen og applikasjonen er robust før den implementer i driftsmiljøet.
Hva er et API?
5 reasons to integrate API Access with READy today
Explore the benefits of API Access. When you integrate the software solution with READy, you gain new features and benefits without losing the features you already know from READy.
1. Automatiser tilgangen til dataene i READy
API Access gir deg en rask, fleksibel og kostnadseffektiv løsning for automatisk integrering av data fra READy fra Kamstrup-målere med andre systemer, uavhengig av den underliggende programarkitekturen i disse systemene. Den gjør at du kan bygge et digitalt økosystem, og dele data på tvers av de forskjellige plattformene dere bruker. API Access støtter mange brukere og forespørsler, og på grunn av programarkitekturen kan systemet vokse med deg og dine behov.
2. Reduser manuelle behandlinger
API Access gjør at programvareutviklere kan automatisere forskjellige oppgaver og prosesser på tvers av systemer og programmer, som GIS og SCADA. Løsningen kan også hjelpe deg med blant annet faktureringsprosessen, siden det er datamaskiner som utfører oppgavene framfor mennesker, noe som gjør at du får en mer effektiv arbeidsflyt, Dette vil også kunne redusere antallet manuelle feil, og kutte kostnader.
3. Hold deg oppdatert
Hold deg oppdatert med avlesningene fra smartmålere med API Access. Du kan abonnere på data fra READy, og hente data ved behov. Sørg for at du har de nyeste dataene så snart de er tilgjengelige, siden API-løsningen garanterer automatisk og øyeblikkelig synkronisering mellom systemer, og vil varsle deg om nye data.
4. Sikre dataene dine
Sikkerhet er førsteprioritet med API Access. Som følge av den underliggende arkitekturen er API en sikrere løsning en alternative metoder for dataoverføring. API Access støtter standardprotokollen for autorisering, OAuth2, og sikrer med dette at det kun er autoriserte brukere som har tilgang til systemet, og som kan utføre de forskjellige API-forespørslene.
5. Kom raskt i gang med REST API
Det er enkelt å komme i gang med API Access hvis du har programmeringskompetanse internt, eller har innhentet hjelp fra noen som har det, siden API Access er basert på de beste løsningene som REST, JSON og OAuth2, og i tillegg er svært godt dokumentert via Swagger UI.
Sammenligning av API Access med eksportfunksjonen i READy. Hva er forskjellen?
Her har vi satt opp noen av de viktigste forskjellene, slik at du kan sammenligne egenskapene til API Access med de til eksportfunksjonen i READy. Når du integrerer Kamstrups API Access vil du fortsatt ha tilgang til eksportfunksjonen i READy – du bare legger til flere funksjoner, og åpner for en mer effektiv dataoverføring, og en større kontroll når du jobber med målerdata.
API Access for utviklere: Hvordan fungerer API Access?
Kamstrup API Access er en kode som styrer tilgangspunkt til READy-serveren. Løsningen fungerer på to måter: Som en standard REST-basert (Representational State Transfer - representativ statusoverføring) API, som er en nettjeneste som gjør at en klient kan komme med forespørsler til ressursene i READy gjennom URL-baner, og som benytter seg av HTTP (Hypertext Transfer Protocol). Dette kan sammenlignes med et besøk på en vanlig nettside der du ber om tilgang til en ressurs som er lagret på en server, og serveren svarer med informasjonen du har bedt om.
Klikk på «Oppdag mer» for mer informasjon om API Access.
Oppdag mer
I tillegg til den vanlige forespørsel-svar-fremgangsmåten, kan API Access fra Kamstrup også jobbe som en webhook API. Med standard REST API blir data presentert på forespørsel, noe som gjør at de blir reaktive. Det betyr at de reagerer på forespørsel, men ikke mer uten at det kommer en forespørsel fra brukeren. Webhook kan derimot håndtere forespørsler (som en forespørsel om innhenting av alle målere) og hendelser (som abonnering på de siste måleravlesningene). Hendelsesdrevet betyr at ett system kan sende data til et annet så snart en gitt hendelse inntreffer. Både webhook og REST API responderer in JSON.
Fra et teknisk ståsted gjør API Access at utviklerne kan automatisere, utvide og kombinere data far enheter som målere i andre systemer eller tjenester, samtidig som det sikres at dataene er sikre. I praksis gjør dette at utviklerne kan skape digitale økosystemer, utvikle apper og tjenester samt utføre andre oppgaver som tidligere kun kunne utføres inne i programpakken fra Kamstrup.
For å kunne integrere READy automatisk med de valgte IT-systemene dere har, må dere ha utviklingskompetanse, siden dette ikke er en del av tilbudet rundt API Access.
Kamstrup tilbyr også produktet «API Access – Development Enviroment», en sandkasse for testing av API-løsninger. Sandkassen gjør at programmerere og utviklere kan prøve ut løsninger uten at det påvirker driftsmiljøet. Den gjør også at tredjepartsutviklere kan skape løsninger og tjenester. Sandkassen for API inneholder testdata fra rundt 5000 målere, slik at utviklere kan teste ny kode, etterligne hendelser fra virkeligheten og skape simulerte responser. Dette er et separat produkt fra API Access, og er tilgjengelig for forsyningsleverandører og utviklere. Med denne løsningen kan potensielle feil i koden bli fanget før den implementeres i driftsmiljøet, noe som reduserer kostnadene og farene ved nye implementeringer.
Er du klar til å begynne å bruke API Access for å få tilgang til data fra READy, og allerede har kjøpt produktet?
Har du fortsatt spørsmål om API Access?
Se svarene på de vanligste spørsmålene
Hva er API Access? Den (korte) tekniske beskrivelsen
READy API Access er et RESTful Application programming Interface (API) som kan benyttes til programmering av apper/programmer og tjenester, samt utføre andre oppgaver som tidligere kun kunne utføres i programpakken til Kamstrup. API Access støtter vanlige REST-forespørsler og webhooks, og er kun tilgjengelig for kunder som hoster løsningen sin i Kamstrups hosting-miljø (tilleggskostnad).
Har dere eksempler på hvordan andre forsyningsleverandører bruker API Access?
Forskjellige forsyningsleverandører bruker API Access til forskjellige ting. Men noen av de vanligste bruksområde er likevel:
- bruke API Access til å bygge en intern dataløsning for å skade det beste datagrunnlaget
- bruke API Access til å integrere READy med faktureringssystemet, slik at faktureringskvaliteten økes
- bruke API Access til å oppdatere READy med data fra målere og målerverktøy fra tredjepart automatisk
- bruke API Access til å integrere data med forbrukerportaler eller forbrukerapper, slik at disse blir oppdatert automatisk med den siste informasjonen
Hva er den generelle fordelen med API Access?
Det er flere fordeler med å bruke API Access. De viktigste fordelene er:
- Gjøre READy klar til å samarbeide med andre systemer
- Automatisere manuelle prosesser
- Kunne benytte seg av oppdaterte dataene og se de nyeste alarmene
- Sikre at endringer i ett system blir reflektert i READy
- Sørge for at data blir sikkert overført mellom systemer
- Sørge for at utviklerne dere har kan komme raskt i gang
Hva er forskjellen mellom en REST-forespørsel og webhook?
Med standard forespørsel-respons-modus med REST API, blir data levert på forespørsel, noe som gjør de reaktive. Det betyr at de reagerer på forespørsler men gjør ingenting på egen hånd. En webhook er på den andre siden hendelsesdrevet, og det betyr at systemet kan sende data til et annet så snart en gitt hendelse har inntruffet.
Er API Access sikker?
Ja. API Access støtter delegert OAuth2-tilgang, som betyr at alle eksterne serviceforespørsler må inneholde et gyldig OAuth2 autentiseringstoken som bæretoken. Autentiseringstoken kontroller at brukerne er hvem de hevder at de er, og at de har tilgangsrettighet til den API-forespørselen de prøver å benytte. Token blir opprettet med utgangspunkt i en leietaker-ID, en kunde-ID og en kundehemmelighet. I tillegg må webhooks/abonnement verifiseres med en API-nøkkel som du kan finne i READy Manager. API Access benytter seg av HTTPS, noe som betyr at TLS-protokollen (Transport Layer Security) blir benyttet til å kryptere standard HTTP-forespørsler og svar. Med API Access blir i tillegg dataene kryptert under overføring med SSL-sertifikater.
Hvordan blir sensitive data håndtert via API Access?
Alle data som blir håndtert via API Access blir håndtert på samme sikre måte. Du finner en introduksjon til hvordan dataene blir sikret ved å se svaret på «Er API Access sikker?» ovenfor.
Hvordan kan jeg komme i gang med API Access?
API Access er en tilleggsmodul i READy, og for å komme i gang må du ta kontrakt med din salgsrepresentant for Kamstrup og bestille tilgang. For å starte byggingen av din egen API Access-løsning, anbefaler vi at du leser veiledningen som heter «Komme i gang med API Access», og se i den nettbaserte dokumentasjonen: EU & US.
Hva er forutsetningene for å kunne starte å bruke API Access?
Du må ta fire enkle trinn for å kunne komme i gang med API Access: (1) Du må være en Kamstrup READy hosted-kunde; (2) Du trenger en aktive -postadresse og et telefonnummer; (3) Du trenger en aktiv server hvis du ønsker å bruke webhooks; og (4) Du trenger programmeringskompetanse internt, eller ha en partner som har dette, siden Kamstrup ikke leverer konsulenttjenester relatert til API-løsningen.
Les mer i databladet “READy – API Access”.
Hvordan kan API Access hjelpe oss med å effektivisere interne arbeidsflyter?
API Access gjør at programvareutviklere kan automatisere forskjellige oppgaver på tvers av systemer og applikasjoner. Det betyr at løsningen blant annet kan hjelpe deg med faktureringsprosessen, siden det er datamaskiner som utfører oppgavene framfor mennesker, noe som betyr at du får en mer effektiv arbeidsflyt, vil redusere antallet manuelle feil, og kutte kostnader.
Når jeg har utviklet løsningen, kan jeg da teste den på testdata?
Kamstrup tilbyr et produkt som heter «API Access – Development Environment» som du kan kjøpe for å test ut løsningen din før du implementerer de i det aktive driftssystemet. Den største fordelen er at dette produktet gjør at du kan programmere og teste koden din uten at testingen ødelegger driftsdata. Ta kontakt med din salgsrepresentant fra Kamstrup for mer informasjon.
Er den nye sandkassen fir API Access, «API Access – Development Environment», inkludert i abonnementet mitt på API Access eller READy?
Nei, sandkassen til API Access er et frittstående produkt. Det betyr at den har egen pris og betingelser. Ta kontakt med din salgsrepresentant fra Kamstrup for tilgang.
Can I get a trial period on API Access before I decide whether I want to buy it?
No. At Kamstrup, we do not offer any form of API Access trials. However, if you decide to buy a subscription, remember that the subscription can always be cancelled.
Can I test new features or upcoming versions of the READy API Access before they are launched?
No. Currently, this is not possible. Features and new versions can first be used when officially released to all API customers.
What will happen when I order API Access?
The first thing that will happen after you order API Access is that you must sign a supplementary agreement containing information about the delivery of API Access and what you can expect. Then, you will receive your tenant ID and client ID via email and your client secret via SMS.
Is the client secret the same as the key found in READy Manager?
No. Your client secret is a piece of information you receive via SMS when you order API Access. The API key in READy Manager is a unique key used to verify webhooks.
Do I need to activate a license when I buy API Access as I did with other Kamstrup software products?
No. All you need to do is to start using the tenant ID, client ID, client secret, and API key when you get them from us.
If one of the info code endpoints returns a list of strings, what can I expect to receive?
By contacting Kamstrup support, you can get a list of possible returned strings in .xml format.
Apart from smart meters from Kamstrup, my distribution network includes pressure sensors from Kamstrup. Can data from these be transferred via API Access?
Yes. If the pressure sensor is from Kamstrup and the unit’s measurements end up in READy as regular readings, which they should do by default, then there should be no problem extracting this data via API Access. If you experience problems, use the service desk to submit a support ticket.
In the API Access Swagger documentation, some endpoints contain /v1/ while others contain /v2/. Is one better than the other?
/v1/ and /v2/ are part of our versioning strategy. The /v2/ endpoints can be seen as a new way to get the same data as is available via the /v1/ endpoints. However, in most cases, the /v2/ endpoints are more straightforward in terms of what must happen in the READy backend for the API to fetch the requested data. Thus, both versions can be used, but /v2/ will most likely provide better stability.
What endpoints do I need to use to authenticate myself?
If you ever stumble upon different authentication endpoints, this is the one to use: https://signon.kamstrup.com/token.
What is API Access? The (short) technical explanation
READy API Access is a RESTful Application Programming Interface (API) that can be used to programmatically create apps and services and perform other tasks that could previously only be accomplished within Kamstrup’s software suite. API Access supports regular REST requests and webhooks and is only available to customers hosted in Kamstrup’s hosting environment (at an additional cost).
Do you have examples of how other utilities use API Access?
Different utilities use API Access for different things. Still, some of the significant use cases that we see are:
- Using API Access to build an in-house data warehouse to create the best possible data foundation
- Using API Access to integrate READy with the billing system to ensure billing conformity
- Using API Access to enable the usage of third-party meter exchange tools to update meter exchanges in READy automatically
- Using API access to integrate data into consumer portals or consumer applications, so these are automatically updated with the newest information
What are the overall benefits of API Access?
There are several benefits to using API Access. The significant advantages are:
- Make READy interoperable with other systems
- Automate manual processes
- Rely on the newest data and alarms
- Reflect changes from one system back into READy
- Securely transfer data between systems
- Get your software developers started quickly
What is the difference between a REST request and a webhook?
In standard request-response REST APIs, data is served upon request, making them reactive. That means that they react upon request but typically do nothing on their own without prompting from the user. On the other hand, a webhook is event-driven, which means it allows one system to send data to another as soon as a given event takes place.
Is API Access secure?
Yes. API Access supports delegated OAuth2 access, which means that all external service calls must include a valid OAuth2 authentication token as a Bearer Token. Authentication tokens check that users are who they claim to be and that they have access rights for the specific API call they are trying to use. The token is created based on a tenant ID, a client ID, and a client secret. Additionally, webhooks/subscriptions need to be verified with an API key found in READy Manager. API Access utilises HTTPS, meaning that the Transport Layer Security (TLS) protocol is used to encrypt standard HTTP requests and responses. With API Access, data is also encrypted during transfer with SSL certificates.
How is sensitive data managed through API Access?
All data managed through API Access is handled in the same secure way. For an introduction to how data is secured, see the answer to “Is API Access secure?” above.
How do I get started with API access?
API Access is an add-on to READy Manager, and to get started, you need to reach out to your Kamstrup sales representative and order access. To begin building your own solutions with API Access, we suggest you read through our how-to guide called “Get started with API Access” and check out our online documentation: EU & US.
What are the prerequisites to start using API Access?
Four easy steps need to be taken for you to start using API Access: (1) You need to be a Kamstrup READy-hosted customer; (2) You need an active email and phone number; (3) You need an active server if you want to use webhooks; and (4) You need to have software development capabilities in-house, or partner with someone who has them as Kamstrup does not deliver consultancy services related to the API.
Read more in the datasheet called “READy – API Access”.
How can API Access help streamline internal workflows?
API Access enables software developers to automate various tasks across systems and applications. This can help improve, for instance, billing workflows as computers rather than people perform tasks which allows you to achieve more efficient and effective workflows by reducing manual errors and cutting costs.
Once I develop my solution, can I test it on non-production data?
Kamstrup offers a product called “API Access – Development Environment”, which you can buy to test out your solutions before implementation in your live system. The primary benefit is that this product allows you to write and test your code without messing up production data. Reach out to your Kamstrup sales representative to hear more.
Is the new API Access sandbox, “API Access – Development Environment”, included in my API Access or READy subscription?
No. The API Access sandbox is a standalone product. This means that it comes with its own separate price and contractual terms. Reach out to your Kamstrup sales representative to order access.
Can I get a trial period on API Access before I decide whether I want to buy it?
No. At Kamstrup, we do not offer any form of API Access trials. However, if you decide to buy a subscription, remember that the subscription can always be cancelled.
Can I test new features or upcoming versions of the READy API Access before they are launched?
No. Currently, this is not possible. Features and new versions can first be used when officially released to all API customers.
What will happen when I order API Access?
The first thing that will happen after you order API Access is that you must sign a supplementary agreement containing information about the delivery of API Access and what you can expect. Then, you will receive your tenant ID and client ID via email and your client secret via SMS.
Is the client secret the same as the key found in READy Manager?
No. Your client secret is a piece of information you receive via SMS when you order API Access. The API key in READy Manager is a unique key used to verify webhooks.
Do I need to activate a license when I buy API Access as I did with other Kamstrup software products?
No. All you need to do is to start using the tenant ID, client ID, client secret, and API key when you get them from us.
If one of the info code endpoints returns a list of strings, what can I expect to receive?
By contacting Kamstrup support, you can get a list of possible returned strings in .xml format.
Apart from smart meters from Kamstrup, my distribution network includes pressure sensors from Kamstrup. Can data from these be transferred via API Access?
Yes. If the pressure sensor is from Kamstrup and the unit’s measurements end up in READy as regular readings, which they should do by default, then there should be no problem extracting this data via API Access. If you experience problems, use the service desk to submit a support ticket.
In the API Access Swagger documentation, some endpoints contain /v1/ while others contain /v2/. Is one better than the other?
/v1/ and /v2/ are part of our versioning strategy. The /v2/ endpoints can be seen as a new way to get the same data as is available via the /v1/ endpoints. However, in most cases, the /v2/ endpoints are more straightforward in terms of what must happen in the READy backend for the API to fetch the requested data. Thus, both versions can be used, but /v2/ will most likely provide better stability.
What endpoints do I need to use to authenticate myself?
If you ever stumble upon different authentication endpoints, this is the one to use:
https://signon.kamstrup.com/token.
La oss komme i gang
Hvordan kan vi hjelpe deg i dag?