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?

API (Application Programming Interface) on eri järjestelmien välillä toimiva tiedonsiirtokoodi. Sen avulla siirretään ja jaetaan dataa vähintään kahden – yleensä eri valmistajien – järjestelmän välillä. Järjestelmien arkkitehtuurilla tai teknologioilla ei ole merkitystä.

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.

READyn vientitoiminto

READy API Access

Datan vientiasetukset

READy Managerin vientitoiminnossa on määritettävä, tapahtuuko datan vienti kerran tunnissa, päivässä, viikossa vai kuukaudessa. Tämän jälkeen datan vienti noudattaa kiinteää aikataulua, jonka tihein asetus on ”kerran tunnissa”.

Tapahtumiin perustuva datan vienti

Kun READy Managerissa on API Access -lisäpalvelu, voit määrittää datansiirron käynnistymään automaattisesti aina tiettyjen tapahtumien yhteydessä tai kun data on siirtovalmiina READyssä. Sinun ei enää tarvitse odottaa kiinteän aikataulun mukaan siirrettäviä lukemia.

Hälytykset annetaan jälkikäteen

Vaikka fyysisen mittarin antamat hälytykset (infokoodit) näkyvätkin READyssä jo hetken kuluttua, joudut tarkistamaan niiden sisällön joko käsin READystä tai odottamaan hälytysten vientitiedostoa, joka saapuu vasta seuraavan ajastetun viennin yhteydessä.

Hälytykset annetaan ajoissa

Voit tilata hälytykset (infokoodit), kun API Access on integroitu READy Manageriin. Saat ilmoituksen heti, kun READy antaa hälytyksen, ja hälytyksen tiedot näkyvät API Accessissa.

Yksisuuntainen datan vienti

READyn vientitoiminnolla on vain yksi päämäärä: hakea dataa READystä ja toimittaa se käytettäväksi READy Managerin ulkopuolella. READyyn ei voida tuoda dataa READyn vientitoiminnolla.

Kaksisuuntainen datan synkronointi

API Access siirtää dataa READystä muihin järjestelmiin. Ja muut järjestelmät voivat lähettää tietoa ryhmiin, asennuskohteisiin ja mittareihin liittyvistä muutoksista takaisin READyyn.

Tavallinen tietosuoja

READy Managerin sisäisellä vientitoiminnolla voidaan viedä dataa SFTP-palvelimelle, FTP-palvelimelle tai sähköpostiin. Nämä kohteet yleensä suojattu käyttäjätunnuksella ja salasanalla.

Kattava tietosuoja

Tiedonsiirto API Accessin kautta edellyttää voimassa olevaa OAuth2-todennustunnistetta, jota varten tarvitaan kolme tietoa: Sovelluksen tunnus (client ID), hakemistotunnus (tenant ID) ja sovelluksen salauskoodi (client secret). Lisäksi data salataan, ja jos käytät myös API Accessin webhooks/subscription-toimintoa, READy Managerin käyttöön tarvitaan myös aktiivinen API-avain.

API Access kehittäjätiimille: Kuinka API Access toimii?

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.

Lisätietoja

Sulje

Tavallisen pyyntö-vastaus-toimintaperiaatteen lisäksi Kamstrup API Access toimii myös webhook-sovellusliittymänä. Vakiomallisissa REST API -sovellusliittymissä dataa lähetetään pyynnöstä eli reaktiivisesti. Nämä sovellusliittymät reagoivat käyttäjän pyyntöön eivätkä yleensä tee mitään omatoimisesti. Webhook käsittelee pyyntöjä (esim. pyyntö hakea lukemat kaikista mittareista) ja tapahtumia (esim. tuoreimpien mittarilukemien tilaus). Sen toiminta perustuu tapahtumaan, eli yksi järjestelmä lähettää dataa toiselle heti, kun tietty tapahtuma aktivoituu. Sekä webhook että REST API lähettävät vastauksensa JSON-muodossa.

API Access toimii kehittäjien apuna teknisellä tasolla, kun mittarien kaltaisten laitteiden dataa halutaan automatisoida, laajentaa ja yhdistää muiden järjestelmien dataan tai palveluihin tietoturvallisuus varmistaen. Käytännössä kehittäjät voivat luoda sen avulla digitaalisen ekosysteemin, kehittää sovellusten ja palveluiden ohjelmistoja ja suorittaa muita tehtäviä, joita pystyttiin aiemmin hoitamaan vain Kamstrupin ohjelmistoissa.

READyn automaattinen integrointi valitsemaasi IT-järjestelmään edellyttää ohjelmistokehitystaitoja, sillä palvelu ei kuulu API Access-tilaukseen.

Kamstrupin tuotevalikoimasta löydät myös API Access -kehitysympäristön, joka on API:n ”sandbox”-testausympäristö. Tässä testausympäristössä ohjelmoijat ja kehittäjät voivat kokeilla erilaisia muutoksia niin, että niiden vaikutukset eivät näy asiakkaiden käyttämässä ympäristössä. ”Sandbox” sopii myös kolmannen osapuolen kehittäjille uusien ratkaisujen ja palveluiden luomiseen. API ”sandbox” siirtää noin 5 000 mittarista testausdataa, jonka avulla kehittäjät testaavat uutta koodia, jäljittelevät oikeita tapahtumia ja simuloivat ratkaisuja. Tämä tuote on saatavana API Accessin lisäpalveluna jakeluyhtiöiden ja kolmannen osapuolen kehittäjien käyttöön. Sen avulla mahdolliset ohjelmavirheet huomataan ennen ohjelman julkaisua, joten sillä saavutetaan kustannussäästöjä ja estetään uusiin ratkaisuihin liittyviä riskejä.

Haluatko aloittaa API Accessin käytön ja hyödyntää hankkimasi READy-ohjelmiston kautta saatavaa dataa?