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?
API er en forkortelse for «application programming Interface» (programmeringsgrensesnitt på norsk) og er kode som fungerer som en bro mellom forskjellige systemer - ofte fra forskjellige leverandører, slik at to eller flere systemer kan kommunisere og dele data uavhengig av underliggende arkitektur eller teknologi.
5 grunner til å integrere API-tilgang med READy i dag
Utforsk fordelene med API-tilgang. Når du integrerer programvareløsningen med READy, får du nye funksjoner og fordeler uten å miste funksjonene du allerede kjenner fra 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.
Kan jeg få en prøveperiode på API-Access før jeg bestemmer meg for om jeg vil kjøpe det?
Nei. Hvis du bestemmer deg for å kjøpe et abonnement, husk at abonnementet alltid kan kanselleres.
Kan jeg teste nye funksjoner eller kommende versjoner av READy API Access før de lanseres?
Nei. Foreløpig er dette ikke mulig. Funksjoner og nye versjoner kan først brukes når de offisielt er lansert til alle API-kunder.
Hva vil skje når jeg bestiller API-Access?
Det første som vil skje etter at du bestiller API-Access, er at du må signere en tilleggsavtale som inneholder informasjon om leveringen av API-tilgang og hva du kan forvente. Deretter vil du motta ditt leietaker-ID og klient-ID via e-post og din klienthemmelighet via SMS.
Er klienthemmeligheten den samme som nøkkelen som finnes i READy Manager?
Nei. Din klienthemmelighet er et stykke informasjon du mottar via SMS når du bestiller API-tilgang. API-nøkkelen i READy Manager er en unik nøkkel som brukes til å verifisere webhooks.
Trenger jeg å aktivere en lisens når jeg kjøper API-tilgang, slik jeg gjorde med andre Kamstrup-programvareprodukter?
Nei. Alt du trenger å gjøre er å begynne å bruke tenant ID, client ID, client secret og API-nøkkel når du får dem fra oss.
Hvis en av informasjonskode-endepunktene returnerer en liste med strenger, hva kan jeg forvente å motta?
Ved å kontakte Kamstrup-støtte, kan du få en liste over mulige returnerte strenger i .xml-format.
I tillegg til smarte målere fra Kamstrup, inkluderer distribusjonsnettverket mitt trykksensorer fra Kamstrup. Kan data fra disse overføres via API-Access?
Ja. Hvis trykksensoren er fra Kamstrup, og enhetens målinger ender opp i READy som vanlige avlesninger, noe de burde gjøre som standard, så skal det ikke være noe problem å hente disse dataene via API-Access. Hvis du opplever problemer, bruk servicedesken for å sende inn en supportforespørsel.
I Swagger-dokumentasjonen for API-Access inneholder noen endepunkter /v1/ mens andre inneholder /v2/. Er den ene bedre enn den andre?
/v1/ og /v2/ er en del av vår versjonsstrategi. /v2/-endepunktene kan sees som en ny måte å få den samme dataen som er tilgjengelig via /v1/-endepunktene. Imidlertid er /v2/-endepunktene i de fleste tilfeller mer enkle i forhold til hva som må skje i READy-backend for at API-en skal hente de forespurte dataene. Derfor kan begge versjoner brukes, men /v2/ vil mest sannsynlig gi bedre stabilitet.
Hvilke endepunkter må jeg bruke for å autentisere meg selv?
Hvis du noen gang snubler over forskjellige autentiseringsendepunkter, er dette det du skal bruke: https://signon.kamstrup.com/token.
La oss komme i gang
Hvordan kan vi hjelpe deg i dag?