Lyhyesti: API on sovittu rajapinta, jonka kautta ohjelmistojärjestelmät vaihtavat pyyntöjä ja dataa. Dokumentaatio määrittelee toiminnot, syötteet, tulosteet, tunnistautumisen ja rajoitukset.
Miten käytän APIa käytännössä
Erotan API-prototyypin tuotantoprosessista. Prototyyppi varmistaa hyödyllisyyden; tuotanto tarvitsee käyttöoikeudet, rajoitukset, seurannan ja varamenettelyn. En pidä tulosta tosiasiana vain siksi, että se kuulostaa vakuuttavalta, vaan jäljitän tärkeät väitteet alkuperäiseen lähteeseen.
Mitä kannattaa seurata
Suurin riski on epäselvän prosessin automatisointi. API tuottaa silloin epäjohdonmukaista tulosta nopeammin ja tekee virheiden jäljittämisestä vaikeampaa. Seuraa arkaluonteista dataa, tuntemattomia palveluehtoja ja päätöksiä, joita ei ole helppo peruuttaa.
Päätöksiä tukevat kysymykset
- Mitä rajattua tehtävää teknologian pitäisi parantaa?
- Mitä dataa saa käyttää ja kuka tarkistaa tuloksen?
- Miten mittaamme tarkkuutta ja kustannuksia todellisissa tapauksissa?
- Miten pysäytämme tai perumme prosessin virheen jälkeen?