Kuinka saada lisää API-käyttäjiä?

Autoin hiljattain yritystä, joka halusi parantaa kehittäjäkokemustaan. Heidän neljännesvuositavoitteensa oli saada vielä enemmän adoptiota ja uusia asiakkaita APIlleen kotimarkkinoillaan Yhdysvalloissa.

He ovat parhaillaan tekemässä kaikkia niitä muutoksia, joita paksu raporttini ehdotti, joten en mainitse nimeä. Mutta sanotaan, että he ovat yksi alansa parhaista ja palvelevat suurimpia asiakkaita, kuten LinkedIniä.

Heidän API-kehittäjien asiakaspolullaan verrattuna kilpailijoiden asiakaspolkuun oli monia ongelmia, joista useimmat olivat hyvin tyypillisiä. Kaikkien tuotepäälliköiden ja kehittäjien hyödyksi halusin jakaa muutamia vinkkejä. Tehdään maailmasta parempi paikka meille API-hyödyntäjille.

Sivustosi ei saa olla kaunis

Yksi tärkeimmistä asioista on, että ihmisten on todella saatava selville ja huomattava, että sinulla on API. Jos suunnittelet kauniin sivuston, jossa on mukava grafiikka, se ei ehkä vieläkään puhu kehittäjän sielulle. Koodarit haluavat sivustosi näyttävän hieman karkealta. On parasta, että se on täynnä teknisiä yksityiskohtia. Poista viimeiseen asti hiotut grafiikat, jotka suorastaan huutavat: "Sinun täytyy puhua ensin myynnille!"

Osana arviointia vertailin myös heidän kilpailijoidensa kehittäjäpolkuja. Päätimme jättää huomiotta muutamia varhaisia ehdokkaita, koska sinun piti puhua myynnin kanssa päästäksesi API: hen. Saatat tuntea kiusausta ajatella, että tämä oli todella hyvä asia, kilpailijoisi ei pitäisi päästä API: hen liian helposti. Muista kuitenkin, että lomakkeet, jotka minun piti täyttää, ja viestit, jotka sain takaisin, olivat suorastaan oveltavia. Joten kehittäjänä olisin juossut kauas niistä joka tapauksessa.

Onko APIsi piilotettu aarre?

Sinun on myös pysähdyttava katsomaan koko verkkosivustoasi jonkun silmin, jolle API voi olla ilahduttava ominaisuus. He eivät ehkä etsi sitä. He voivat olla projektipäälliköitä, tuotepäälliköitä, arkkitehteja tai liikemiehiä. Varmista, että API erottuu päätuotesivuilla, äläkä piilota sitä verkkosivustosi alatunnisteen viimeiseksi linkiksi.

On myös monia muita tapoja saada APIsi muiden tietoisuuteen, mutta tämä on helppo korjata.

‍

Rakasta, älä vihaa kehittäjiä

Mikä tekee kehittäjät onnellisiksi, sen jälkeen kun he ovat saaneet selville, että sinulla on API? Kirjailijaystäväni Jarkko Moilanen käyttää UI-mittareita API rajapintoihin: 3-30-3-sääntö sanoo, että

• Kehittäjän on ymmärrettävä 3 sekunnissa, miksi API on tarjolla ja minkä ongelman se ratkaisee?
• 30 sekunnin pitäisi riittää APIn kokeilemiseen ja ensimmäisen pyynnön tekemiseen
• Kehittäjän tulee kyetä käyttämään APIa kolmessa minuutissa omalla koodillaan

Tämä kuulostaa vaikealta, mutta olen tosissani. Jos kehittäjäkokemuksesi ja asiakaskokemuksesi eivät vastaa näitä mittareita, prospektisi siirtyvät seuraavaan APIin. Tai jos kyseessä on sisäisiä kehittäjiäsi tai palkattua apua, he ovat motivoimattomia ja laskutavat sinua enemmän. Jos API ei tee jotain, mitä mikään muu API ei ratkaise, tai jos yrityksesi on alansa paras, saatat päästä pälkähästä hitaamman prosessin kanssa. Mutta älä välitä siitä.

Jotkin yritykset ovat ratkaisseet tämän tarjoamalla vain koodiesimerkkejä API-dokumentaationa. He näyttävät ajattelevan, että hyppääminen prosessin viimeiseen vaiheeseen on tärkein. Mutta ei, älä mene oikoteitä. Jos potentiaaliset API-kuluttajasi eivät ymmärrä, miksi heidän pitäisi käyttää API-liittymääsi, mikä tahansa heille tarjoamasi koodi ei tule olemaan ratkaisu.

Se ei tarkoita, että esimerkki koodien tai ohjelmistokehityspakettien tarjoaminen ei olisi hyvä asia. Se on hyödyllistä vain, jos sinulla on resursseja niiden ylläpitoon. Jos Githubisi sanoo "viimeksi päivitetty 4 vuotta sitten", kehittäjät näkevät sen "hylättynä" ja siirtyvät eteenpäin. Maailmassa ei ole ohjelmointikieltä, joka ei tarvitsisi joitain päivityksiä joka vuosi. Ja APIsi on todennäköisesti päivitetty joka tapauksessa, joten mitkä ovat mahdollisuudet, että ohjelmointikehityspaketti toimisi enää.

Varmista, että on olemassa prosessi, jossa vastataan kysymyksiin ja ongelmiin, jotka tulevat kehittäjiltä SDK-arkiston kautta. Ota huomioon, että omat kehittäjäsi eivät välttämättä katso hyvällä niitä jotka arvostelevat heidän työnjälkeään.

Roolit ja työkalut apuun

Jos luet tätä edelleen, ajattelet todennäköisesti, että APIn tarjoaminen edellyttää, että sinulla on käytössäsi armeija kehittäjiä ja toinen armeija käyttäjäkokemuksen asiantuntijoita. Ei, mutta APIsi tarvitsee tuotemanagerin. Enkä tarkoita Scrumissa käytettyä Product Owneria, vaan tuotepäällikköä, joka käsittelee APIa tuotteena, asiakkaiden kanssa. Heidän tehtävänään on selittää myynnille, markkinoinnille, asiakaspalvelulle ja kehittäjille, mitä ongelmia API ratkaisee. Mitä arvoa se tarjoaa asiakkaille?

Tuotepäällikön tehtävänä on myös varmistaa että dokumentaatio ja kehittäjämatka toimivat. Tuotepäällikön on työskenneltävä yhdessä yhteisön johtajan kanssa. Heidän yhteinen tehtävänsä on varmistaa, että yhteisöltäsi tulevat ongelmat ja ominaisuuspyynnöt priorisoidaan ja niihin vastataan.

Entä koodi, SDK:t ja dokumentaatio? Luo APIsi Open API -määrityksen avulla. Tai luo se vähintään koodista. Sitten dokumentaation ja koodiesimerkkien suhteeen olet jo puolivälissä. Varmista, että Open API -dokumentaatio sisältää pyyntö- ja vastausesimerkkejä. Tämän jälkeen voit käyttää API-hallinta alustoja tai avoimen lähdekoodin työkaluja. Työkalut voivat luoda sekä dokumentaation että koodiesimerkit eri kielillä automaattisesti. Tässä on myös muita etuja. API-kuluttajasi voivat käyttää Open API -asiakirjaa koodissaan ja automaattisessa testauksessaan. OpenAPI-dokumentaation avulla voit myös simuloida APIa ennen koodin kirjoittamista tai koko koodia ja luoda testejä.

Kuvassa on esimerkki IBM Cloud API Connect -kehittäjäportaalista. Se käyttää Swagger-käyttöliittymää sisäisesti ja antaa käyttäjän ladata OpenAPI-asiakirjan sekä kopioida automaattisesti luodun esimerkkikoodin eri kielillä.

‍

Yksi helppo työkalu muistaa on myös Postman. Voit kopioida koodiesimerkkejä mistä tahansa API-pyynnöstä, jonka teet siellä. Postman tukee OpenAPI-liittymää ja alkuperäisiä Postman-kokoelmia APIen julkaisemiseen.

Tässä videossa voit nähdä vilauksen siitä, mitä eroa hyvällä kehittäjäkokemuksella on APIn käyttöönotolle. Video näyttää, miten voit tehdä yksinkertaisia pyyntöjä valuuttakurssi APIlle Postmanin avulla.

‍

‍

‍