Ohjelmointirajapinnan käyttöönottoprosessi kannattaa hallita asiakaskeskeisesti. Liiketalouden näkökulmasta tähän liittyy asiakkaan arvoketju (Customer Value Chain), joka kuvaa prosessia tarpeen tunnistamisesta käyttöönottoon.
Kehittäjäkokemukseen vaikuttavat
suunnitteluvaiheen päätökset
käytön aikainen tuki.
Alla on lueteltu hyvin toteutetun ohjelmointirajapinnan ominaisuudet, jotka optimoivat sen tehokkuuden, käytettävyyden ja pitkän elinkaaren.
Ominaisuus
Kuvaus
Helppo oppia
Ohjelmointirajapinnan ominaisuudet ja käyttötarkoitus on helppo ymmärtää.
Helppo käyttää
Käyttö ei vaadi suurta perehtymistä dokumentaatioon.
Vaikea väärinkäyttää
Suunnittelu ohjaa oikean käytön.
Helppo laajentaa
Uusien ominaisuuksien lisääminen on vaivatonta.
Vastaa asiakastarpeisiin
Ominaisuudet vastaavat asiakkaiden tarpeita.
Luettavissa oleva lähdekoodi
Lähdekoodi on selkeää ja helposti ylläpidettävää.
Tehokkuus
Ohjelmointirajapinta toteuttaa tehokkaasti sille asetetut tavoitteet.
Toimialatieto: Ohjelmointirajapinta kuvaa toimialaa ja käyttää sen käsitteitä. Selkeä dokumentaatio parantaa käytettävyyttä.
Käyttömallit: Miten ohjelmointirajapintaa käytetään ja miksi eri käyttötavat ovat perusteltuja.
Toimintakuvaus: Miten ohjelmointirajapinta toimii (syötteet ja tulosteet) ja miten se integroituu sovellukseen
Hyvä dokumentaatio on kerroksellista. Se antaa nopeasti tietoa ohjelmointirajapinnan toiminnasta ja käyttötilanteista sekä esimerkkejä (kysymyksiä ja vastauksia). Laajakin dokumentaatio voidaan tiivistää verkkosivulle.
Ohjelmointirajapintoja kehitetään käytettäväksi, ja ulkopuolelle julkaistujen ohjelmointirajapintojen dokumentointi on ensiarvoisen tärkeää. Organisaation sisäiset termit voivat olla ulkopuolisille vieraita. Huomioi, että tietoa ohjelmointirajapinnoista etsivät liiketoiminta- ja ohjelmistokehittäjät, joiden tietotarpeet eroavat.
Liiketoimintakehittäjät tarvitsevat tietoa siitä, miten ohjelmointirajapinta voi tukea liiketoimintaa.
He etsivät vastauksia seuraaviin kysymyksiin:
Mitä arvoa tai hyötyä sen käytöstä saa?
Miten paljon sen käyttö maksaa?
Miten sitä voi käyttää?
Miten nopeasti sen saa käyttöön ja mitä se vaatii?
Mitä vaihtoehtoja sen käytölle on?
Miten se auttaa onnistumaan?
Ohjelmistokehittäjät tarvitsevat teknisempää tietoa, kuten OpenAPI-kuvauksia ja ohjelmistokehityspaketteja (SDK). He myös tarvitsevat testiympäristöjä ja selkeitä ohjeita käyttöoikeuksien hankkimiseen.
Yleinen ongelma on, että ohjelmistokehittäjä ei löydä ohjelmointirajapintaa, ja usein OpenAPI-kuvaukset eivät vastaa käytännön toteutusta. Kehittäjäkokemusta voidaan parantaa valmiilla ohjelmistokehityspaketeilla, jotka helpottavat ohjelmointirajapinnan käyttöä.
Esimerkiksi liitteenä olevan Stripen esimerkin julkaisema JavaScript-kirjasto mahdollistaa ohjelmointirajapinnan hyödyntämisen mahdollisimman helposti, vain seitsemällä rivillä koodia.
