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

Autoin äskettäin yritystä, joka halusi parantaa kehittäjäkokemustaan. Heidän neljännesvuositavoitteenaan oli saada entistä enemmän uusia API-asiakkaita USA:n kotimarkkinoillaan.

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

Heidän sekä heidän kilpailijoidensa API-kehittäjäkokemuksessa oli monia ongelmia, joista useimmat olivat hyvin tyypillisiä. Kaikkien tuotepäälliköiden ja kehittäjien hyväksi 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 kehittäjien piti puhua myynnin kanssa päästäkseen rajapintoihin käsiksi. Saatat ajatella, että tämä oli todella hyvä asia, kilpailijoisi ei pitäisi päästä rajapintoihisi liian helposti. Muista kuitenkin, että lomakkeet, jotka piti täyttää, ja viestit, jotka sain takaisin, olivat suorastaan luotaantyöntäviä. 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 alaosan 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

Kuulostaa ehkä vaikealta, mutta olen tosissani. Jos kehittäjäkokemuksesi ja asiakaspolkusi eivät ole priimaa, prospektisi siirtyvät seuraavaan APIin. Tai jos he ovat sisäisiä kehittäjiäsi tai ulkoisia toimittajia, he ovat epämotivoituneita ja laskuttavat sinua enemmän. Jos APIsi on erittäin hyödyllinen ja auttaa ratkaisemaan haasteita tai jos yrityksesi on alansa paras, saatat selvitä hitaammallakin prosessilla. Mutta älä laske sen varaan

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ää APIasi, mikäään heille tarjoamasi koodi ei tule riittämään.

Se ei tarkoita, että esimerkiksi koodien tai ohjelmistokehityspakettien (SDK) 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 niinkään, mutta APIsi tarvitsee tuotepäällikön. 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än asiakaspolku ja kehittäjäkokemus 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 kehityspyynnöt priorisoidaan ja niihin vastataan.

Entä koodi, SDK:t ja dokumentaatio? Luo APIsi käyttäen Open API spesifikaatiota. Tai ainakin luo se koodista. Siten olet jo puolivälissä dokumentaation ja koodiesimerkkien tarjoamisessa. Varmista, että Open API dokumentaatio sisältää pyyntö- ja vastausesimerkkejä. Tämän jälkeen voit käyttää API-hallintaratkaisuja tai avoimen lähdekoodin työkaluja. Työkalut voivat luoda sekä dokumentaatio- että koodiesimerkkejä eri kielillä automaattisesti. Tällä on myös pari muuta etua. API-hyödyntäjäsi voivat käyttää Open APIa koodinsa dokumentointiin ja automaattiseen testaukseen. OpenAPI-dokumentaatiota voi käyttää myös testaamaan ja simuloimaan ("mokkaamaan") APIa ennen kuin koodia on kirjoitettu riviäkään.

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.


Lue lisää aiheesta

Tutustu uusimpiin uutisiin ja parhaisiin käytäntöihin

Ollaan yhteyksissä!

Emme lähetä mitään turhaa, vain asiaankuuluvaa sisältöä enintään 1-2 kertaa kuukaudessa.