Mikä on API...ja vähän rajapintapalvelustakin

Esitetty API-seminaarissa 28.1.2016.

Transcript

1. Mikä on API? Jarkko Moilanen (jarkko.moilanen@minedu.fi) API – seminaari 28.1.2016, VRK Sisällön lisenssi: Creative Commons 4.0 BY-SA • Share — copy and redistribute the material in any medium or format • Adapt — remix, transform, and build upon the material for any purpose, even commercially. Esitys ladattavissa https://speakerdeck.com/kyyberi
2. Kenelle tuttu?
3. ”Paljon parempi juttu kuin yksittäisen junan kulkutietojen haku VR mobiilissa” ”Hieno juttu, mutta VR:llä on varmasti ollut tämä data hallussa jo vuosia. Miksei VR itse ole luonut tällaista palvelua?” ”Antakaa kaverille oikeasti noobeli! Toimii paremmin ku teän vessat !” ”Hyvä VR! Hienoa kun nostatte tätä!” ”VR:n kannattaisi rekrytoida tollanen tyyppi heti luomaan heille uusia digitaalisia palveluita.” ”Kannattasko VR:n vaihtaa ylikallis järjestelmätoimittaja Joonakseen?” ”Mulle on lähijunan käyttäjänä tästä paljon enemmän hyötyä kuin VR:n omasta Junat kartalla-ohjelmasta, joka ei edes minulla toimi kunnolla iPhonessa.” Kansalaisten kommentteja Onhan näitä muitakin mutta tästä saatiin sanakaritarina – tarinat myy Massan asiakastarpeet huomioitiin paremmin
4. Avoin API Esityksen kehikko Arkkityypit Iso kuva kansallisesti – digitalisaatio ja ohjeistus Rajapinnat palveluna Rajapinta ja rajapintapalvelu Rajapintapalvelun kehittäminen Asiakas API- strategia Kehittäjä- kokemus
5. Kärkihanke: Digitalisoinnin periaatteet ”Tietovarantomme ja rajapintamme ovat julkisesti saatavilla, koneluettavissa ja avoimin käyttöehdoin, ellei saatavuutta ole erikseen tarvetta rajata”[DRAFT] Lähde: Aleksi Kopponen (VM) 5.1.2016 https://www.innokyla.fi/web/tyotila2001351/periaate- tietovarantomme-ja-rajapintamme-ovat-julkisesti-saatavilla- koneluettavissa-ja-avoimin-kayttoehdoin-ellei-saatavuutta- ole-erikseen-tarvetta-rajata
7. API:t ja asiakas
8. Mikä on rajapinta eli API? ohjelmat voivat tehdä pyyntöjä ja vaihtaa tietoja eli keskustella keskenään. API Data Tablet tietokone PC Sovellus
9. Rajapinta vs graafinen käyttöliittymä Selain on graafinen käyttöliittymä ihmisiä varten Rajapinta (API) on käyttöliittymä ohjelmistoja varten
10. API on osa datan ravintoketjua
11. Rajapinta ja rajapintapalvelu • rajapinta on tekninen toteutus • rajapintapalvelu sisältää palvelulupauksen, ohjeet ja oppaat, hallinnan, metatiedot, yms… palataan tähän
12. Suljettu API – sisäinen, omien järjestelmien integroinnit Kumppani API – sopimuksellinen yhteistyö (palveluväylä) – organisaatio – organisaatio – henkilökohtainen tieto: organisaatio – yksilö (mydata) Avoin API – hyödyntäjiä ei tiedetä etukäteen, ei sopimuksia – vain avointa tietoa Rajapintojen arkkityypit
13. Avoimet rajapinnat
14. Pitäähän sillä avaamisella olla tarkoitus, miksi avaisimme? Innovaatiot tapahtuu organisaation ulkopuolella rekisteriajattelu – katsotaan tynnyrin sisälle mahdollistaja - katsotaan tynnyristä ulos, edes siitä pikku reiästä Haaste
15. Avoin rajapinta ”Avoin rajapinta on rajapinta, jonka kaikki ominaisuudet ovat julkisia ja jota voi käyttää ilman rajoittavia ehtoja (esimerkiksi laatia rajapintaa hyödyntävän ohjelman ilman rajapinnan valmistajan erillistä hyväksyntää tai pakollisia lisenssimaksuja)” Lähde: http://avoinrajapinta.fi/
16. Avoin rajapinta  Avoimesti dokumentoitu  Rajapinta on määritelty ja sen dokumentaatio on verkon kautta avoimesti saatavilla ja vapaasti käytettävissä.  Käyttöönotettava  Avoin rajapinta on mahdollista ottaa käyttöön ilman ylläpitäjän tai järjestelmätoimittajan toimia  Tämän ei tarvitse tarkoittaa pääsyä tuotantojärjestelmään, eikä vaatimus siten estä tuotantojärjestelmän käyttövaltuuksien hallintaa.  Testattava  Rajapinnan tulee olla testattavissa. Testausta varten on tarjolla on vähintään testiaineisto.
17. Avoin rajapinta  Ei edellytä koodin avoimuutta  Toisaalta koodin avoimuus ei tarkoita asiakastietojen avoimuutta  Ei tarvitse pääsyä tuotantojärjestelmään, eikä vaatimus siten estä tuotantojärjestelmän käyttövaltuuksien hallintaa.  Avoimen rajapinnan kautta saatavan datan ei tarvitse olla avointa dataa  Esimerkiksi potilastietojärjestelmään voi olla avoin rajapinta, mutta potilastiedot eivät ole avoimia.
18. Kehittäjäkokemus (DX) Miten saat kehittäjät rakastamaan rajapintojasi
19. Asiakasnäkökulma • Rajapintapalvelun asiakas on ohjelmisto, mutta sen käytön mahdollistaa vain koodaaja • Puhutaan kehittäjäkokemuksesta (Developer eXperience) – rajapintapalvelujen teknisen kehittämisen lähtökohta
20. (Asiakas) Kehittäjäkokemus • Miten hyvin ja helposti kehittäjä löytää rajapinnat, niiden käyttöön liittyvät tiedot/ehdot, ymmärtää rajapinnan tarkoituksen sekä miten nopeasti pääsee tekemisen alkuun • Kehittäjäkokemuksen mittaaminen: – TTFHW – Time to First Hello World – 3-30-3
21. TimeToFirstHelloWorld …ja miten lyhentää sitä Kopioitavat koodiesimerkit Ajantasainen helppokäyttöinen dokumentaatio Rajapinnalla selkeä tarkoitus Automatisoitu, nopea rekisteröityminen Työkaluja (API konsoli, yms) (Asiakas) Kehittäjäkokemus
22. (Asiakas) Kehittäjäkokemus 3-30-3 •3 sekunnissa ymmärtää miksi rajapinta on olemassa •30 sekunnissa päästä tiedon lähteille •3 minuutissa: tunnukset ja ensimmäinen API:n kokeilu
23. Yksi piste josta pääsee tiedon äärelle – kehittäjien kielellä – ”Suomi SDK” ? KEHITTÄJÄLLE
24. ”Suomi SDK” (ei ole olemassa, paloja on) APIstelu (palveluväylän API:t ja avoimet API:t) Tarinoita sovelluksista Dokumen- taatiot API luettelo, Metatiedot, tuotannossa ja kehityksessä olevat Koodiesi- merkit & SDK:t Komponentti katalogi Yhteentoimivuus … Palaute kanava Koneluetta- vat API kuvaukset Avoimille rajapinnoille itsepalvelutyyppinen kokemus
25. APIKA (apika.digipalvelutehdas.fi)
26. Rajapintapalvelun kehittäminen Rajapinta tuotteena on rajapintapalvelu
27. Liiketoimintasuunnitelma + KA API -strategia API -liiketoimintasuunnitelmat Lean & Agile Design API (MVP) Swagger, JSON API, Open API Definition Format API Model Canvas Lean frameworks (Node.js etc) Automaation hyödyntäminen Hallintamalli (ekosysteemi) Avoimen rajapinnan hallintamalli API vain jäävuoren huippu
28. API Days 2016 Finland • Osa globaalia API Days tapahtumasarjaa • 18.-19.5.2016, Tampereella • Teemat: – Kansallisen palveluväylän asiat (business ja kehittäjät) – Valmistavan teollisuuden API-talous • Puhujat kutsutaan: 18F (US) ja Government Digital Service (UK) joukoista, X-Road asiantuntijat Virosta, suuryrityksistä kuten KoneCranes, Kone ja API-maailman edelläkävijöiden joukosta
29. "Suomi muutetaan maaksi, jossa ensin innovoidaan. Sitten tutkitaan miten lainsäädäntö sopii innovaatioon ja muutetaan tarvittaessa lainsäädäntöä. …Nykyään ideasta seuraava vaihe on keskustelu Suomen byrokratian hyväksynnästä, ei idean jalostamisesta. Tälläisellä järjestyksellä syntyisi ongelmia, mutta Suomen taloutta edistäviä innovaatioita syntyisi moninkertaisesti enemmän." Lähde: Tuntematon somesoturi Kiitos