Yli 50 kysymystä, joita sinun tulee kysyä myyjän sovellusliittymästä ennen alustan valitsemista

Hyvä ystävä ja mentori kirjoitti minulle kysymyksen kanssa, ja haluaisin käyttää vastauksiani tähän viestiin. Hänen kysymyksensä keskittyivät enemmän yhteen toimialaan (sähköposti), joten olen yleistänyt vastaukseni. Hän kysyi, mitä kysymyksiä yrityksen tulisi kysyä myyjältä sovellusohjelmointirajapinta API ennen valintaa.

Miksi tarvitset sovellusliittymiä?

API:t ovat ratkaisevan tärkeitä eri järjestelmien, sovellusten ja palvelujen saumattoman integroinnin mahdollistamisessa. Kun esimerkiksi käytät mobiilisovellusta sään tarkistamiseen, sovellus yleensä kommunikoi ulkoisen palvelun API:n kanssa hakeakseen ajantasaiset säätiedot. Toinen yleinen esimerkki ovat sosiaalisen median alustat, joiden avulla kehittäjät voivat integroida ominaisuuksia, kuten sisällön jakamista tai lähettämistä muista sovelluksista.

Aivan kuten kirjoitat a URL ja saada vastaus takaisin verkkosivulle, API on menetelmä, jossa järjestelmäsi voivat pyytää ja saada vastauksen takaisin synkronoidakseen tietoja niiden välillä. Kun yritykset haluavat muuttaa itseään, tehtävien automatisointi sovellusliittymien avulla digitaalisesti on loistava tapa parantaa organisaation tehokkuutta ja vähentää inhimillisiä virheitä.

API-rajapinnat ovat keskeisiä automaatiossa, erityisesti markkinointisovelluksissa. Yksi haaste kattavan ja erinomaisen toimittajan etsimisessä API Kehitysresurssit ja -kulut ovat yleensä jälkikäteen. Markkinointitiimi tai YMJ voi johtaa sovelluksen ostoon, ja joskus kehitystiimi ei saa paljon palautetta.

Millaisia ​​API:ita on olemassa?

On olemassa monia erilaisia ​​API-tekniikoita, joista jokaisella on omat erityispiirteensä ja käyttötapauksensa. Sovelluksellesi parhaiten sopiva API-teknologian tyyppi riippuu erityistarpeistasi ja vaatimuksistasi. Tässä on kuusi yleistä API-teknologian tyyppiä:

1. REST-sovellusliittymät: REST API:t ovat eräänlainen verkkosovellusliittymä, joka käyttää HTTP-menetelmiä (kuten GET, POST, PUT ja DELETE) tietojen hakemiseen ja käsittelemiseen. Ne on suunniteltu kevyiksi ja joustaviksi, ja niitä käytetään usein verkko- ja mobiilisovellusten rakentamiseen.
2. SOAP API:t: SAIPPUA (Simple Object Access Protocol) API:t ovat verkkosovellusliittymätyyppejä, joita käytetään XML (Extensible Markup Language) tietojen koodaamiseen ja lähettämiseen HTTP:n kautta. SOAP API:t ovat standardoituja ja jäsenneltympiä kuin REST API, ja niitä käytetään usein yritysympäristöissä, joissa turvallisuus ja luotettavuus ovat tärkeitä.
3. GraphQL-sovellusliittymät: GraphQL on sovellusliittymien kyselykieli, jonka avulla kehittäjät voivat pyytää tiettyjä tietoja API:lta kiinteän tietojoukon vastaanottamisen sijaan. GraphQL-sovellusliittymät ovat joustavia ja antavat kehittäjille mahdollisuuden pyytää vain tarvittavia tietoja, mikä voi parantaa suorituskykyä ja vähentää tietojen hukkaa.
4. Webhooksit: Webhookit ovat eräänlainen API-tekniikka, jonka avulla palvelin voi lähettää tietoja asiakkaalle reaaliajassa sen sijaan, että asiakkaan tarvitsee pyytää tietoja palvelimelta. Niitä käytetään usein mahdollistamaan reaaliaikainen viestintä sovellusten välillä ja käynnistämään toimintoja tiettyjen tapahtumien sattuessa.
5. Pilvisovellusliittymät: Pilvisovellusliittymien avulla kehittäjät voivat käyttää pilvipalveluita, kuten tallennustilaa, tietokantoja ja analytiikkaa, ja olla vuorovaikutuksessa niiden kanssa. Nämä sovellusliittymät voivat auttaa kehittäjiä rakentamaan ja ottamaan käyttöön sovelluksia tehokkaammin ja tehokkaammin.
6. Laitteiston sovellusliittymät: Laitteiston sovellusliittymien avulla kehittäjät voivat käyttää ja ohjata laitteita, kuten antureita, kameroita ja tulostimia. Nämä API:t voivat rakentaa sovelluksia, jotka ovat vuorovaikutuksessa fyysisten laitteiden kanssa ja ohjaavat niitä.

Jos kirjaudut sisään sovelluksella, jonka sovellusliittymä on huonosti tuettu tai dokumentoitu, teet kehitystiimisi hulluksi ja integraatiosi epäonnistuvat todennäköisesti tai epäonnistuvat kokonaan. Löydä oikea toimittaja, niin integraatiosi toimii, ja kehityshenkilösi auttavat mielellään!

Tutkimuskysymykset heidän API-ominaisuuksistaan:

Alustan integrointiominaisuuksien tutkiminen API:n kautta vaatii muutakin kuin yksinkertaisen kysymyksen: Onko olemassa API: ta? On jatkokysymyksiä! Tässä on kattava luettelo kysymyksistä, joita yritykselle voi kysyä niiden API-liittymistä, ja se kattaa useita kriittisiä näkökohtia, kuten versioinnin, säännösten noudattamisen, turvallisuuden, käytettävyyden ja paljon muuta:

Yleiskatsaus

1. Mikä on API:si ensisijainen tarkoitus ja miten se sopii yhteen yrityksesi yleisstrategian kanssa?
2. Mitä API-tyyppejä tarjoat (REST, SOAP, GraphQL jne.)?
3. Onko API:ssasi ainutlaatuisia ominaisuuksia, joita kilpailijat eivät tarjoa?

Ominaisuusvaje-analyysi

4. Mitkä käyttöliittymäsi ominaisuudet ovat käytettävissä API:n kautta?
5. Onko API:ssa eksklusiivisia ominaisuuksia, jotka eivät ole käyttöliittymässä tai päinvastoin?
6. Kuinka usein julkaiset uusia ominaisuuksia, ja julkaistaanko niitä samanaikaisesti sekä käyttöliittymälle että API:lle?

Versiointi ja päivitykset

7. Kuinka hoidat API:si versioinnin?
8. Miten asiakkaille ilmoitetaan API-versioiden käytöstä poistamisesta tai merkittävistä muutoksista?
9. Onko olemassa taaksepäin yhteensopivia päivityksiä vai vaativatko uudet versiot koodimuutoksia asiakaspuolella?
10. Tuetko useita versioita samanaikaisesti? Jos on, kuinka kauan?

Skaalautuvuus ja suorituskyky

11. Kuinka monta API-puhelua palvelimillesi tehdään päivittäin?
12. Onko API:lle olemassa oma palvelinpooli vai jakaako se resursseja muiden palvelujen kanssa?
13. Kuinka käsittelet skaalausta kysynnän kasvaessa? Onko sinulla varauksia äkillisiin liikenteen piikkeihin?

Dokumentointi ja tuki

14. Voimmeko käyttää API-dokumentaatiota? Kuinka usein sitä päivitetään?
15. Onko dokumentaatiossa yksityiskohtaisia ​​selityksiä jokaisesta ominaisuudesta ja muuttujasta?
16. Onko koodiesimerkkejä, SDKtai kirjastoja eri kielille ja kehyksille?
17. Mitä tukikanavia on saatavilla API-ongelmiin? (esim. live chat, sähköposti, tilivastaava)

Kehittäjäyhteisö ja resurssit

18. Onko sinulla online-kehittäjäyhteisö koodin, parhaiden käytäntöjen ja integraatiokokemusten jakamiseen?
19. Onko kehittäjäfoorumeita, UKK, tai tietokannat erityisesti API-käyttäjille?
20. Onko sinulla integraatioresursseja tai sisäisiä konsultteja asiakkaiden käytettävissä?
21. Voitko tarjota referenssejä tai yhteystietoja yrityksiltä, ​​jotka on integroitu sovellusliittymäänne?

Integraation yhteensopivuus

22. Mitä tietomuotoja API tukee (esim. JSON, XML, jne.)?
23. Mitkä alustat, sovellukset ja ohjelmointikielet on integroitu onnistuneesti API:si kanssa?
24. Onko olemassa tuotteistettuja integraatioita kolmannen osapuolen kanssa (3P) työkaluja?
25. Tarjoatko kirjaston koodinäytteitä integrointiponnistelujen nopeuttamiseksi?
26. Voimmeko käyttää hiekkalaatikkoa tai ei-tuotantoympäristöä testausta varten?

Rajoitukset ja hintarajoitukset

27. Mitä API-nopeusrajoituksia on käytössä (esim. puhelut sekunnissa, minuutissa, tunnissa)?
28. Onko käytössä erilaisia ​​nopeusrajoituksia käytettävien tietojen tyypin mukaan?
29. Ovatko hintarajoitukset neuvoteltavissa käyttötasojen tai tilaussuunnitelmien perusteella?

Turvallisuus ja vaatimustenmukaisuus

30. Miten API todentaa käyttäjät? (esim. API-avaimet, OAuth, tunnuspohjainen jne.)
31. Onko olemassa vaihtoehtoja rajoittaa API-käyttöä? IP-osoite tai sijainti?
32. Mitä salausstandardeja noudatat siirrettävälle ja levossa oleville tiedoille?
33. Onko olemassa tiettyjä viranomaissertifikaatteja, joita API noudattaa, kuten? GDPR, HIPAAtai PCI DSS?
34. Mitä tietosuojatoimenpiteitä on käytössä kansainvälisten säännösten noudattamisen varmistamiseksi?

10. Luotettavuus ja käytettävyys

35. Mikä on API:si keskimääräinen käyttöaika?
36. Tarjoatko julkisen käytettävyyden hallintapaneelin?
37. Mikä on virheprosentti ja miten sitä seurataan?
38. Onko sinulla tiettyjä huoltoaikoja ja miten asiakkaille ilmoitetaan?
39. Onko käytössä automaattisia uudelleenyritysmekanismeja seisokkien tai käyttökatkojen varalta?

Palvelutasosopimukset (SLA)

40. Tarjoatko palvelusopimusta API:llesi, ja mikä on taattu käyttöaika?
41. Mikä on tyypillinen vastausaikasi API-ongelmiin, kuten SLA:ssa on kuvattu?
42. Onko SLA-rikkomuksista olemassa taloudellisia tai palveluhyvityksiä?

Tuleva tiekartta

43. Voitko jakaa etenemissuunnitelman API:n tulevista ominaisuuksista ja päivityksistä?
44. Kuinka usein uusia versioita tai suuria päivityksiä julkaistaan?
45. Otatko asiakkaita mukaan uusien ominaisuuksien betatestaukseen tai palauteistuntoihin?

Seuranta ja kirjaaminen

46. Tarjoatko kirjaus- tai seurantatyökaluja API-toiminnalle?
47. Voivatko asiakkaat käyttää käyttötilastoja seuratakseen puhelumääriä, virhemääriä ja suorituskykyä?
48. Onko olemassa sisäänrakennettuja työkaluja käyttäjien toiminnan seurantaan ja poikkeavuuksien havaitsemiseen?

Laskutus- ja hinnoittelurakenne

49. Mikä on API-käytön hinnoittelumalli (esim. pay-per-call, porrastettu tilaus)?
50. Peritäänkö korkeammista käyttömääristä tai premium-ominaisuuksista lisämaksuja?
51. Voidaanko hinnoittelua räätälöidä määrän tai erityisten käyttötapausten perusteella?

Integrointi- ja käyttöönottoprosessi

52. Mikä on uusien API-käyttäjien tyypillinen käyttöönottoprosessi?
53. Tarjoatko konsulttipalveluita alkuasennuksen ja integroinnin avuksi?
54. Kuinka kauan integraation loppuun saattaminen yleensä kestää ja mitä resursseja tarvitaan?

Nämä kysymykset ymmärtävät perusteellisesti yrityksen API:n, mukaan lukien sen ominaisuudet, rajoitukset ja tukirakenteen. Tämä lähestymistapa on ratkaisevan tärkeä valittaessa sovellusliittymää, joka vastaa tarpeitasi, tukee tulevaa kasvua ja tarjoaa liiketoimintakriittisille sovelluksille tarvittavan luotettavuuden ja turvallisuuden.

Avain näihin kysymyksiin on, että integraatio "liittää" sinut alustaan. Ethän halua mennä naimisiin jonkun kanssa tietämättä heistä mahdollisimman paljon, vai mitä? Näin tapahtuu, kun ihmiset ostavat alustan tietämättä sen integrointiominaisuuksia.

API:n lisäksi sinun tulee myös yrittää selvittää, mitä muita integrointiresursseja heillä voi olla: Viivakoodaus, kartoitus, tietojen puhdistuspalvelut, RSS, verkkolomakkeet, widgetit, viralliset kumppaniintegraatiot, komentosarjakoneet, SFTP tippaa jne.