API Access READy-datan saumattomaan jakamiseen
Mikä API Access on?
Kamstrup API Access on turvallinen tekniikka, jonka avulla READy jakaa dataa muiden järjestelmien – kuten asiakasportaalien, GIS- tai SCADA-järjestelmien – kanssa. Näin muodostuu digitaalinen ekosysteemi, jonka kautta voidaan jakaa eri järjestelmien tietoja, parantaa asiakaspalvelua sekä optimoida toimintoja ja työnkulkuja.
API Access on READy-järjestelmän lisäpalvelu, joka helpottaa järjestelmien välistä tietoturvallista tiedonsiirtoa. API Access on saatavana Kamstrupin hostauspalvelua käyttäville READy-asiakkaille. Sitä ei voida tilata paikallisesti asennettuihin READy-järjestelmiin. Kaikki tutut READy-toiminnot ovat edelleen käytössäsi. API Access sujuvoittaa tiedonsiirtoa ja toimii kätevästi READyyn integroituna ratkaisuna.
Kamstrupin ”sandbox” on jakeluyhtiöille ja kolmannen osapuolen kehitystiimeille tarkoitettu turvallinen testausympäristö, jossa voidaan kehittää ja testata API Accessin käyttöä. Tällä lisätoiminnolla sovellus ja sen integrointi voidaan optimoida mahdollisimman vakaaksi ennen tuotantoympäristöön siirtymistä.
Mikä API on?
5 syytä integroida API Access heti READyyn
Tutustu API Accessin etuihin. Kun integroit ohjelmistoratkaisun READyyn, saat käyttöösi uusia toimintoja ja etuja menettämättä kuitenkaan ennestään tuttua READy-sisältöä.
1. Automatisoi yhteytesi READy-dataan
API Access on nopea, monikäyttöinen ja kustannustehokas tapa integroida Kamstrup-mittarien READy-data automaattisesti muihin järjestelmiin. Järjestelmien arkkitehtuurilla ei ole merkitystä. API Accessin avulla rakennat digitaalisen ekosysteemin ja jaat dataa eri alustojen välillä. API Access tukee useita samanaikaisia käyttäjiä. Ohjelmistoarkkitehtuurinsa ansiosta järjestelmää on helppo laajentaa vastaamaan liiketoimintasi muuttuvia tarpeita.
2. Manuaalisesta automatiikkaan
API Accessin avulla ohjelmistokehittäjät voivat automatisoida eri tehtäviä ja prosesseja useissa järjestelmissä ja sovelluksissa, kuten GIS- tai SCADA-järjestelmässä. Se tehostaa esimerkiksi laskutusta valjastaen prosessit tietokoneiden tehtäväksi. Työnkulkujen tehokkuus paranee, näppäilyvirheiden määrä vähenee ja kulut pysyvät kurissa.
3. Aina ajan tasalla
API Accessin avulla pysyt aina ajan tasalla älymittarien datasta. Voit tilata dataa suoraan READystä ja hakea on-demand-lukemia. Voit myös hyödyntää aina uusinta dataa, sillä API hoitaa järjestelmien välisen synkronoinnin välittömästi ja automaattisesti sekä ilmoittaa, kun uutta dataa on käytettävissä.
4. Varmista tietoturva
API Accessissa tietoturva on aina etusijalla. API:n arkkitehtuuri vahvistaa ratkaisun tietoturvaa huomattavasti paremmaksi kuin vaihtoehtoisissa tiedonsiirtomenetelmissä. API Access tukee yleistä OAuth2-todennusprotokollaa, joten ainoastaan todennetut käyttäjät voivat kirjautua järjestelmään ja käyttää tiettyjä API-toimintoja.
5. Helposti alkuun REST API:n avulla
API Accessin käyttöönotto sujuu helposti, jos yrityksessäsi tai liikekumppanillasi on ohjelmistokehitystiimi. API Access perustuu parhaisiin tekniikoihin, kuten REST, JSON ja OAuth2. Sen kattava dokumentaatio on saatavana Swagger UI:ssa.
Vertailussa API Access ja READyn vientitoiminto. Kuinka ne eroavat toisistaan?
Seuraavassa vertailemme API Accessin toimintoja ja READyn vientitoimintoa viiden eroavaisuuden avulla. Integroituasi Kamstrup API Accessin järjestelmiisi voit edelleen käyttää myös READyn vientitoimintoa. Integroinnilla saat käyttöösi lisätoimintoja, tehostat tiedonsiirtoa ja voit käsitellä mittaridataa entistä kattavammin.
API Access kehittäjätiimille: Kuinka API Access toimii? Kamstrup API Access on koodi, joka hallitsee READy-palvelimen
Kamstrup API Access on koodi, joka hallitsee READy-palvelimen päätelaitteita. Se toimii kahdella tavalla: Vakiomallin REST (Representational State Transfer) API:na eli verkkopalveluna, jonka kautta sovellus (client) voi pyytää READy-dataa URL-polkujen ja HTTP:n (Hypertext Transfer Protocol) kautta. Toimintaperiaate vastaa tilannetta, jossa haet palvelimelle tallennettua tavallista verkkosivua ja palvelin vastaa näyttämällä pyytämäsi sivun.
Tutustu API Accessiin napsauttamalla Lisätietoja-painiketta.
Lue lisää
Kamstrup API Access voi toimia normaalin pyyntö-vastaustavan lisäksi myös webhook API:na. Tavallisissa REST API:ssa data toimitetaan pyynnöstä, mikä tekee niistä reaktiivisia, eli ne toimivat pyynnöstä, mutta eivät tee mitään itsenäisesti ilman käyttäjän antamaa kehotetta. Webhook puolestaan voi käsitellä pyyntöjä (kuten pyyntöjä hakea kaikki mittarit) ja tapahtumia (kuten tilata uusimmat mittarilukemat). Tapahtumapohjaisuus tarkoittaa, että järjestelmä voi lähettää tietoa toiselle heti, kun annettu tapahtuma tapahtuu. Sekä webhook että REST API vastaavat JSON:issa.
Teknisestä näkökulmasta API Access mahdollistaa kehittäjien automatisoinnin, tiedon laajentamisen ja yhdistämisen mittarien kaltaisista laitteista muihin järjestelmiin tai palveluihin varmistaen samalla tietoturvan. Käytännössä tämä mahdollistaa kehittäjien luoda digitaalisen ekosysteemin, kehittää ohjelmallisesti sovelluksia ja palveluita sekä suorittaa muita tehtäviä, jotka oli aiemmin mahdollista suorittaa vain Kamstrupin ohjelmistopaketin sisällä.
Jos haluat yhdistää READy:n automaattisesti valittuun IT-järjestelmään, sinulla on oltava ohjelmistokehityskykyjä, sillä tämä ei sisälly API Access -tarjoukseen.
Kamstrup tarjoaa myös tuotteen "API Access – Development Environment", API-sandboxin, jossa testaaminen on mahdollista. Sandbox sallii ohjelmoijien ja kehittäjien kokeilla muutoksia muuttamatta mitään tuotantoympäristössä. Se mahdollistaa myös kolmannen osapuolen kehittäjien luoda ratkaisuja ja palveluita. API-sandbox tarjoaa testidataa noin 5000 mittarista, joka mahdollistaa kehittäjille uuden koodin testaamisen, tosielämän tapahtumien jäljittelemisen ja simuloitujen vastausten luomisen. Se on erillinen tuote API Accessista ja saatavilla palvelu- ja kolmannen osapuolen kehittäjille. Sen avulla mahdolliset virheet saadaan kiinni ennen toteutusta, mikä vähentää uusien vastausten kustannuksia ja riskejä.
Oletko valmis aloittamaan API Accessin käytön päästäksesi READy:n dataan ja oletko jo ostanut ohjelmiston?
Onko sinulla kysyttävää API Accessista?
Tutustu yleisimpiin kysymyksiin vastauksineen
Mikä API Access on? (Lyhyt) tekninen kuvaus
READy API Access on REST-arkkitehtuuriin perustuva ohjelmointirajapinta (API), jolla voidaan ohjelmoida sovelluksia ja palveluita ja suorittaa muita tehtäviä, joita pystyttiin aiemmin hoitamaan vain Kamstrupin ohjelmistoissa. API Access tukee tavallisia REST-pyyntöjä ja webhookeja, ja se on saatavissa vain asiakkaille, joiden järjestelmä toimii (lisämaksullisessa) Kamstrup-hostausympäristössä.
Kuinka API Accessia käytetään eri jakeluyhtiöissä?
Eri jakeluyhtiöt käyttävät API Accessia eri asioihin. Sitä käytetään yleisimmin näihin tarkoituksiin:
- API Accessin avulla laaditaan yrityksen sisäinen tietovarasto, joka toimii mahdollisimman luotettavasti
- READy integroidaan laskutusjärjestelmään API Accessin avulla, jotta laskutus toimii tarkasti
- API Accessin avulla otetaan käyttöön kolmannen osapuolen mittarinvaihtotyökaluja, jotta vaihdetut mittarit päivittyvät automaattisesti READyyn
- API Accessin avulla integroidaan dataa asiakasportaaleihin tai asiakassovelluksiin, jotta uusimmat tiedot päivittyvät niihin automaattisesti
Millaisia yleisiä etuja API Accessilla on?
API Accessin käyttö on hyödyllistä monin tavoin. Merkittävimmät edut ovat:
- READy saadaan toimimaan yhteen muiden järjestelmien kanssa
- Se automatisoi manuaaliset prosessit
- Käytettävissä on aina uusin data ja ajankohtaiset hälytykset
- Toiseen järjestelmään tehdyt muutokset synkronoituvat myös READyyn
- Järjestelmien välinen datasiirto on tietoturvallista
- Ohjelmistokehittäjät pääsevät nopeasti työnsä alkuun
Mitä eroa on REST-pyynnöllä ja webhookilla?
REST API -ratkaisuissa on tavallinen pyyntö-vastaus-toimintaperiaate, jossa dataa siirretään pyynnöstä eli reaktiivisesti. Ne reagoivat käyttäjän pyyntöön eivätkä yleensä tee mitään omatoimisesti. Webhookin toiminta perustuu tapahtumaan eli yksi järjestelmä lähettää dataa toiselle heti, kun tietty tapahtuma aktivoituu.
Onko API Access turvallinen?
Kyllä. API Access tukee delegoitua OAuth2-käyttöoikeutta eli kaikissa ulkoisissa palvelupyynnöissä on oltava voimassa oleva OAuth2-todennustunniste, jota käytetään valtuutusotsikkona (Bearer Token). Todennustunnisteet tarkastavat käyttäjien henkilöllisyyden ja käyttöoikeuden siihen API-toimintoon, jota he yrittävät käyttää. Todennustunnistetta varten tarvitaan sovelluksen tunnus (client ID), hakemistotunnus (tenant ID) ja sovelluksen salauskoodi (client secret). Sen lisäksi webhookit/tilaukset on todennettava READy Managerista löytyvällä API-avaimella. API Access käyttää HTTPS-protokollaa, eli tavalliset HTTP-pyynnöt ja -vastaukset salataan TLS-protokollalla (Transport Layer Security). API Accessissa myös datansiirto salataan SSL-varmenteilla.
Kuinka arkaluonteista dataa käsitellään API Accessissa?
Kaikkea API Accessin kautta hallittavaa dataa käsitellään samalla tietoturvallisella tavalla. Datan tietoturva on esitelty edellä vastauksessa kysymykseen ”Onko API Access turvallinen?”.
Kuinka pääsen alkuun API Accessin kanssa?
API Access on READy Managerin lisäpalvelu. Pääset alkuun ottamalla yhteyttä lähimpään Kamstrup-myyntiedustajaasi ja tilaamalla käyttöoikeuden. Kun haluat toteuttaa oman ratkaisusi API Accessin avulla, suosittelemme lukemaan API Access -aloitusoppaamme ja tutustumaan verkosta ladattaviin asiakirjoihin: EU ja Yhdysvallat.
Millä edellytyksillä voi aloittaa API Accessin käytön?
Aloita API Accessin käyttö neljän helpon vaiheen kautta: (1) Tilaa ensin READyn hostauspalvelu Kamstrupilta; (2) Tarvitset käytössä olevan sähköpostiosoitteen ja puhelinnumeron; (3) Tarvitset käytössä olevan palvelimen, jos haluat käyttää webhookeja; ja (4) Yrityksessäsi tai liikekumppanillasi on oltava ohjelmistokehitystiimi, sillä Kamstrup ei toimita API-konsulttipalveluita.
Lue lisää ”READy – API Access” -esitteestä.
Kuinka API Access selkeyttää sisäisiä työnkulkuja?
API Accessin avulla ohjelmistokehittäjät voivat automatisoida eri tehtäviä ja prosesseja useissa järjestelmissä. Se tehostaa mm. laskutusta valjastaen prosessit tietokoneiden tehtäväksi. Työnkulkujen tehokkuus paranee, näppäilyvirheiden määrä vähenee ja kulut pysyvät kurissa.
Kun oma ratkaisu on kehitetty, voiko sitä testata julkaisemattomalla datalla?
Kamstrupin tuotevalikoimasta löydät myös API Access -kehitysympäristön, jossa voit testata ratkaisujasi ennen kuin ne julkaistaan asiakkaiden käyttämässä järjestelmässä. Tärkein etu on, että tämän tuotteen avulla voit kirjoittaa ja testata koodiasi aiheuttamatta kaaosta tuotantoympäristöön. Kysy lisää Kamstrupin myyntiedustajalta.
Kuuluuko uusi API Access ”sandbox” eli ”API Access -kehitysympäristö” tilaamaani API Access- tai READy-ratkaisuun?
Ei. API Access ”sandbox” on erillinen tuote. Siitä veloitetaan erillinen maksu ja sitä koskevat eri sopimusehdot. Tilaa se käyttöösi Kamstrupin myyntiedustajalta.
Onko API Accessista saatavana kokeilujakso, jonka aikana voin päättää sen hankinnasta?
Ei. Kamstrup ei tarjoa API Access -kokeilujaksoja. Muistathan silti, että jos päätät tilata maksullisen palvelun, voit perua tilauksen tarvittaessa.
Voiko READy API Accessin uusia toimintoja tai tulevia versioita testata ennen niiden julkaisua?
Ei. Se ei ole mahdollista tällä hetkellä. Uusia toimintoja tai versioita voi käyttää vasta, kun ne on virallisesti julkaistu kaikille API-asiakkaille.
Kun tilaan API Accessin, mitä tapahtuu ensimmäiseksi?
Kun olet tilannut API Accessin, allekirjoitat ensin lisäsopimuksen, joka sisältää tietoa API Accessin toimituksesta ja seuraavista vaiheista. Sen jälkeen saat meiltä sähköpostitse hakemistotunnuksen (tenant ID) ja sovelluksesi tunnuksen (client ID) ja tekstiviestitse sovelluksesi salauskoodin (client secret).
Onko sovelluksen salauskoodi sama kuin READy Managerista löytyvä avainkoodi?
Ei. Saat sovelluksesi salauskoodin tekstiviestitse tilattuasi API Accessin. READy Managerista löytyvä API-avain on yksilöllinen avainkoodi, jolla vahvistetaan webhookeja.
Täytyykö minun aktivoida lisenssi, kun ostan API Accessin (kuten muiden Kamstrup-ohjelmistotuotteiden oston yhteydessä)?
Ei tarvitse. Pääset alkuun suoraan käyttämällä hakemistotunnustasi (tenant ID), sovelluksesi tunnusta (client ID), sovelluksesi salauskoodia (client secret) sekä API-avainta.
Jos jonkin infokoodin kohdalla näkyy vain merkkijonoja, mistä tiedän, mitä ne tarkoittavat?
Ota yhteyttä Kamstrupin tukeen, niin lähetämme sinulle luettelon mahdollisista merkkijonoista .xml-tiedostona.
Täytyykö minun aktivoida lisenssi, kun ostan API Accessin (kuten muiden Kamstrup-ohjelmistotuotteiden oston yhteydessä)?
Ei tarvitse. Pääset alkuun suoraan käyttämällä hakemistotunnustasi (tenant ID), sovelluksesi tunnusta (client ID), sovelluksesi salauskoodia (client secret) sekä API-avainta.
API Access Swagger -asiakirjassa mainitaan kahdenlaisia päätepisteitä: /v1/ ja /v2/. Kumpi näistä on parempi?
/v1/ ja /v2/ liittyvät versiointistrategiaamme. /v2/-päätepisteet ovat uudenlainen tapa saada käyttöön /v1/-päätepisteiden välittämää dataa. Useimmiten /v2/-päätepisteiden avulla on kuitenkin selkeämpi määrittää READy-palvelimen toiminnot, joilla API hakee pyydettyä dataa. Siksi molempia versioita voi käyttää, mutta /v2/ on todennäköisesti vakaampi ratkaisu.
Minkä päätepisteiden kautta todennan itseni käyttäjänä?
Jos vastaasi tulee erilaisia todennuksen päätepisteitä, käytä tätä: https://signon.kamstrup.com/token.
Käydään suoraan asiaan
Miten voimme olla sinulle avuksi?