Kartoita hallintatyökalut

Ensimmäiseksi teidän kannattaa kartoittaa ja valita ohjelmointirajapintojen hallintotyökalut. Hallintatyökalujen avulla saatte ohjelmointirajapintoihin liittyvän varsinaisen työn etenemään nopeasti ja vältätte turhaa työtä.

Tärkeimpiä hallintatyökaluja ovat

• Kehittäjäportaali
• API gateway
• API manager
• API analytiikka.

Kuva: Ulkoisesta tietojärjestelmästä sisäiseen tietojärjestelmään.

Näytä kuva suurempana

Valitse hallintatyökalu seuraavien perusteiden mukaan:

1. Kustannukset ja käytön helppous: Pilvipohjaiset ratkaisut ovat usein kustannustehokkaita ja helposti käyttöönotettavia.
2. Perustarpeiden kattavuus: Varmista, että työkalu tukee kaikkia API-hallinnan keskeisiä toimintoja (esimerkiksi käyttöoikeuksien hallinta, valtuuksien tarkistaminen ja käyttöseuranta).
3. Yhteensopivuus: Työkalun tulee toimia saumattomasti organisaation nykyisen infrastruktuurin kanssa.
4. Jatkuvuus: Varmista, että API-hallintatyökaluilla on pysyvä rahoitus, joka ei ole riippuvainen yksittäisistä projekteista.

Hallintatyökaluja toimittavat

• yleisesti käytetyt pilvipalvelutoimittajat
• erilliset järjestelmätoimittajat
• avoimen lähdekoodin hankkeet.

Ratkaisujen perustoiminnallisuudet ovat helposti verrattavissa toisiinsa.

Käytännössä usein tärkeämpää on se, että ratkaisu toimii yhteen organisaation muun infrastruktuurin kanssa kuin se, millaisia eroja yksittäisten ratkaisujen hallintaominaisuuksissa on.

API-kehittäjäportaali on internetsivusto, jonka avulla ohjelmistokehittäjät löytävät ja testaavat ohjelmointirajapinnat ja pyytävät käyttöoikeutta niihin.

Kehittäjäportaali on yksi paikka, missä on kaikki organisaation ohjelmointirajapinnat listattuna ja löydettävissä.

Se sisältää ajan tasalla olevan kuvauksen kahdessa muodossa:

1. luettavassa muodossa
2. kehittäjien työkalujen automaattisesti hyödynnettävässä muodossa.

Kehittäjäportaali auttaa dokumentoimaan organisaation ohjelmointirajapinnat riittävän yhtenäisellä tavalla. Parhaimmillaan se luo sisällöntuotantoon rakenteen, jota noudattamalla kuvataan ohjelmointirajapinnat yhtenäisellä tavalla. Silloin ulkopuolisen tai uuden ihmisen on helppo ymmärtää niiden toiminta ja tarjoama lisäarvo.

Kehittäjäportaali voi myös sisältää

• valmiita referenssitoteutuksia siitä, miten ohjelmointirajapintaa hyödynnetään
• analytiikkatietoa siitä, miten ohjelmointirajapinnat toimivat
• häiriötiedotteita
• tietoja ohjelmointirajapintojen versioinnista ja elinkaaresta
• yhteistietoja siihen, keneltä saa apua käyttöönottoon tai vikailmoituksen tekoon.

Julkisen sektorin organisaatio hallinnoi tyypillisesti kymmeniä tai satoja ohjelmointirajapintoja. Jokaisessa on lähtökohtaisesti samat perustarpeet:

• käyttöoikeuksien hallinta
• käytön seuranta
• käyttöön kohdistuvat rajoitukset ja priorisoinnit.

Näiden samojen perusasioiden tekeminen uudestaan jokaisen ohjelmointirajapinnan kohdalla on turhaa työtä.

Keskitetty julkaisukanava eli API Gateway on ohjelmisto, joka

• huolehtii ohjelmointirajapintojen käyttöoikeuksien ja valtuuksien hallinnasta
• tietoturvapolitiikojen toimeenpanosta
• tietoliikenteen hallinnasta ja priorisoinnista
• taustalla toimivien tietojärjestelmien kokonaiskuormituksen rajoittamisesta ja hallinnasta
• välimuistin käytöstä.

Kuva: API gatewayn tehtävät.

Näytä kuva suurempana

Kaikilla pilvipalveluiden tarjoajilla on tarjolla omat tuotteensa ja tarjolla on myös avoimen lähdekoodin tuotteita.

API gateway on myös tehokas suunnitteluperiaate ja arkkitehtuurimalli. Se on keskitetty yhteyspiste, joka piilottaa monimutkaisuuden ja keskittää todennus-, käytönseuranta ja tietoliikenteen rajoitukset. Lue lisää: Charest, G. 2020. API Principles and Practices Use of the API Gateway and Portal. Harvardin yliopisto (englanniksi)Avautuu uuteen ikkunaan..

Ohjelmointirajapintojen käytöstä kertyy nopeasti miljoonia rivejä lokimerkintöjä. Niistä on usein työlästä päätellä kokonaiskuvaa. Siksi tarvitaan ohjelmistoa, joka tuottaa analyysia lokimerkinnöistä ja visualisoi tietoa ihmiselle helpommin ymmärrettävään muotoon.

Lokitietoja havainnoiksi muuttava analytiikka on lähes välttämätön osa ohjelmointirajapintojen hallinnan kokonaisuutta.

Analytiikka auttaa kaikkia osapuolia erilaisten vikatilanteiden selvittämisessä. Lisäksi se mahdollistaa tietopohjaisen päätöksenteon ohjelmointirajapintoihin liittyvissä asioissa. Tietoa kannattaa jalostaa kehittämisen, liiketoiminnan, asiakashallinnon ja tietoturvallisuuden käyttöön. Ohjelmointirajapinnan lokit voivat toimia esimerkiksi kokonaiskuvaa luovan tietoturvavalvomon (Security Operation Center, SOC) yhtenä tietolähteenä.

API-analytiikan tehtävä on pitää kirjaa siitä, mitä ohjelmointirajapintoja kukin käyttäjä on käyttänyt, miten ja milloin. Vapaasti saatavien tietojen osalta kiinnostavaa on käytön määrä kokonaisuutena ja sen jakauma. Käyttöoikeudeltaan rajatun tiedon osalta tärkeäksi muodostuu myös epäselvissä tilanteissa käytön tarkastaminen. Joissakin käyttötapauksissa jopa yksittäisen tietosisällön ja käyttäjätunnuksen tarkkuudella.

Hallintatoiminnallisuus eli API manager on tarkoitettu ohjelmointirajapintojen operoijien käyttöön.

Tietojärjestelmässä määritellään

• mitkä ohjelmointirajapinnat ovat käytössä
• mitä niiden taustalla toimivia tietojärjestelmiä ne kutsuvat
• ohjelmointirajapintaprotokollat
• tunnistautumistavat
• käyttöoikeudet.

Hallintatoiminnallisuudessa tehdyt määrittelyt siirretään API gateway -osioon, joka käytännössä toteuttaa halutut toiminnallisuudet.

Hallintatyökaluun voi kuulua myös selain- tai erillinen sovellus, jolla ohjelmointirajapintojen määrittely on helpompaa. Määrittelytyökalun lopputuloksena on joukko rajapintamääritelmiä muiden hallintajärjestelmän osioiden käyttöön.

Organisaation sisäisten ohjelmointirajapintojen hallinta voi poiketa ulkoisista ohjelmointirajapinnoista.

Sisäisten ohjelmointirajapintojen hallintaan on kolme yleisesti käytettyä vaihtoehtoa:

1. Ei erillistä hallintaa: Jos tekninen dokumentaatio on hyvin saatavilla ja ohjelmointirajapintojen käyttäjämäärät ovat pieniä, voi erillinen hallinta olla tarpeetonta. Käyttöohjeet voivat sisältyä muun kehittäjä- ja ylläpitotiimien käytössä olevaan dokumentaatioon. Tämä malli voi sopia erityisesti pieniin ja rajattuihin ympäristöihin.
2. Sama hallintaratkaisu kuin ulkoisille ohjelmointirajapinnoille: Jos sisäisiä kehittäjätiimejä on paljon tai halutaan hyötyä systemaattisuudesta, sisäiset ohjelmointirajapinnat voidaan hallita samalla tavalla kuin ulkoiset. Tällöin suositellaan, että API Gateway sijaitsee samassa konesalissa tai pilvipalvelussa organisaation muiden palveluiden kanssa, jotta tietoliikennehäiriöiden vaikutuksia voidaan minimoida.
3. Service mesh -malli: Tässä mallissa sisäisten ohjelmointirajapintojen hallintaa varten luodaan erillinen järjestelmä ja kehittäjäportaali, kuten vaihtoehdossa kaksi, mutta tietoliikenneyhteydet muodostetaan suoraan kutsuvasta tietojärjestelmästä ohjelmointirajapintaa tarjoavaan tietojärjestelmään. Tämä yhdistää hallittavuuden ja tehokkuuden, mutta voi vaatia enemmän opettelua alussa.