Ką reiškia API? API naudojimo pavyzdžiai

API reiškia „Application Programming Interface“. Ir nors tai gali skambėti keistai, jei esate naujokas programavime, juos lengva suprasti, kai jį suskirstote. Jūs juos naudojate net kasdien valdydami mobilųjį telefoną, asmeninį kompiuterį ar naršydami internete.

Programinė įranga, įskaitant žiniatinklio programas, mobiliąsias programas ir daugelį kitų programų, sujungia pasaulį per internetą. Tačiau norint tai padaryti efektyviau, tarp šios programinės įrangos turi būti komunikacijos kanalas - čia yra API.

Čia paaiškinsime API reikšmę ir kaip jas naudoti.

Kas yra API?

Ar žinote, kaip jūs galite pamatyti vaizdo įrašus tokiose srautinėse platformose kaip „Netflix“ ir „YouTube“, be kitų? Tai įmanoma, nes siunčiate užklausą per API.

Ar jūs įsivaizdavote, kaip jūs mokate už prekes, kurias perkate iš internetinių parduotuvių, tokių kaip „Amazon“ ir „eBay“? Taip yra todėl, kad tarp jūsų banko ir apsipirkimo programų yra ryšio kanalas, žinomas kaip API.

Be to, API yra sąsaja su taisyklių rinkiniu, leidžiančiu jūsų programos serveriui sąveikauti su sprendimų teikėjo serveriu, kad galėtumėte naudoti jų išteklius. Iš esmės jis apibrėžia, kaip programos ar programinė įranga bendrauja tarpusavyje.

Tačiau kai kuriais atvejais API leidžia keistis duomenimis tarpusavyje. Pavyzdys yra ryšys, egzistuojantis tarp jūsų banko programų ir internetinės parduotuvės programų.

API yra kaip pasiuntinys. Viename gale jis jungiasi prie teikėjo serverio, o kitame gale taip pat pritvirtina kliento serverį. Tada ji pateikia kliento užklausą duomenų šaltiniui (teikėjo serveriui) ir pateikia atsakymą klientui. Klientas čia yra naršyklė arba jūsų programa.

Tačiau kabliukas prideda jūsų programą prie API. Tai yra API galas. Tačiau užkulisiuose atsiskleidžia daugybė dalykų. Mes paaiškinsime tai toliau.

Kaip API padeda greičiau kurti programas

API yra protingesnis įrankis kuriant vientisas ir patikimas programas. Be jų sudėtingų programų kūrimas užtruktų.

Įsivaizduokite, kad jums reikalinga programa, kad galėtumėte atlikti sudėtingas operacijas, tokio tipo kūrimas reikalauja daug laiko ir pastangų. Tada kažkas pasirodo su paruošta programa, kuri daro tiksliai tai, ko norite, ir galbūt geriau.

Bet kaip galite tai prijungti prie savo programos? Teikėjas, suprasdamas, kad tai gali suteikti jums šiek tiek laiko, tada pasakė, kad jie sukūrė ryšio sąsają (API), kuri leidžia jų ir jūsų kodą sklandžiai integruoti.

Ta sąsaja (API) prisijungia prie serverio, kuriame yra jų kodas. Tada jis pateikia jums svarbius duomenis iš jų scenarijaus veiksmo.

Žinoma, jūs nenorite sau nuobodžiauti viso jų šaltinio scenarijaus. Be to, dauguma šiuolaikinių API dabar remiasi standartizuota REST („Representational State Transfer“) technologija. Tai daro juos labai keičiamus ir lengvai integruojamus, jums nereikia jaudintis dėl to, kas vyksta jūsų atsakyme, ar būsenos, kai jie iš anksto suformatuoti.

Šiame straipsnyje toliau nebus aiškinama „REST“ API. Kol kas sutelkite dėmesį į pagrindus.

Prijungti kodą prie jų yra geresnė idėja nei rašyti jį nuo nulio. Tačiau norint tai padaryti, turite susieti savo kodą su jų pateikta API. Kaip tai padaryti? Štai kur atsiranda API galinis taškas.

Kas yra API pabaigos taškas?

Tuomet, norėdami supaprastinti dalykus, teikėjai įdėjo URL, kad prisijungimas prie jų API būtų sklandus. Toks URL yra API galinis taškas. Naudodamiesi ja, programa gali pasiekti savo serverį per API ir tiesiogiai bendrauti su savo scenarijumi.

Taigi viskas, ką jums reikia padaryti, tai patraukti galinį tašką, įklijuoti jį į savo kodą, pateikti su juo užklausas, pritaikyti atsakymus ir tada jis veikia, ir tai jūsų! Todėl API galinis taškas susieja jūsų programą per API su sprendimu ar duomenų šaltiniu.

Galų gale daugelis programų, siūlančių API, yra prieinamos įvairiomis programavimo kalbomis, kad niekas nebūtų pašalintas iš jų naudos.

Tokiu būdu greičiau ir efektyviau pasieksite kodą, žinodami, kad API palaikymo pareiga tenka ne jums, o duomenų ar sprendimų teikėjams.

Todėl API galinis taškas yra ryšio kabliukas, kuris viename krašte susieja API su išteklių serveriu, o kitame gale sujungia ją su imtuvo serveriu.

Tada tai reiškia, kad jums nereikia viso norimo naudoti sprendimo scenarijaus. Bet jūsų kodas negali užmegzti ryšio su juo, jei jis neprisijungia prie savo API galinio taško.

API integravimo taisyklės

Nėra griežtos API integravimo taisyklės. Jų yra daugybė, ir kiekviena iš jų turi savo integracijos taisykles. Tačiau nepamirškite, kad tikitės atsakymą kaskart užmezgant ryšį su API.

Tai, kaip teikiate užklausas per API galutinį tašką, paprastai grindžiamas teikėjo apibrėžtomis taisyklėmis, tačiau tai, ką darote su gautu atsakymu, priklauso nuo jūsų pageidavimų. Iš esmės galite jį susukti taip, kaip norite, kad atitiktų programos naudotojų patirtį ir sąsają.

Kartais jums reikia autentifikavimo priemonės, kad galėtumėte pasiekti API. Tokie autentifikatoriai paprastai būna prieigos raktai arba API raktai. Kai šis prieigos raktas praeina autentifikavimo testą, API signalizuoja apie savo galinį tašką, kad būtų užmegztas ryšys tarp jūsų programos ir teikėjo serverio.

Kaip API vartotojui, jums nereikia jaudintis dėl šių parametrų, nes API teikėjas juos suteikia. Puiki API taip pat turėtų nurodyti, kaip jūs galite pasiekti ir naudoti jos išteklius savo dokumentuose. Taigi visada atkreipkite dėmesį į tai bandydami integruoti.

Norėdami jį suapvalinti, API skambutis yra apie antraštes, an galutinis taškas, prašymą, ir atsakymą arba kūnas.

Nors mes paaiškinome, kas yra galutinis taškas, suskirstykime toliau šias kitas sąlygas:

Antraštės

Paprastai prisijungdami prie API turite apibūdinti dvi antraščių formas: prašymą ir atsakymą antraštes.

The užklausos antraštė yra API skambučio vartai. Jis apibūdina kliento požiūrį į prieigą prie išteklių. Tai gali išsamiai apibūdinti tokius dalykus, kaip priimtinas ryšio tipas, tarpinio serverio informacija ir duomenų tipas (JSON, XML arba HTML), kuriuos norite gauti iš API.

Kaip aprašėme anksčiau, atsižvelgiant į API, prie kurio jungiatės, tipą, gali tekti pateikti unikalų autentifikavimo prieigos raktą užklausos antraštėje. Teikėjas dažniausiai tai duoda.

The atsakymo antraštė, kita vertus, yra duomenų, gaunamų iš teikėjo serverio, tvirtinimas. Tai suteikia jūsų programai informaciją apie teikėjo ypatybes. Iš esmės tai užtikrina, kad jūsų programa suteikia prieigą prie atsakymo, gaunamo iš API.

API užklausa

API užklausoje galutinis taškas paprastai yra URL (unikalus šaltinis). Jis naudoja hiperteksto perdavimo protokolą (HTTP), kad surastų ištekliaus, kurį bandote pasiekti naudodamas API, adresą. Galiausiai API užklausa nėra išsami, jei į URL neįtraukiate pabaigos taško.

API atsakymas

Atsakymas yra tai, ką API siunčia atgal kiekvieną kartą, kai gauna užklausą iš jūsų programos. Tai gali būti JSON, XML arba HTML, atsižvelgiant į duomenų ar turinio tipą, kurį jis gauna iš jūsų užklausos antraštės.

Gavę atsakymą iš API, galite laikyti, kad jūsų API skambutis yra sėkmingas.

Kaip naudotis API: praktiniai pavyzdžiai

Dabar, kai žinote API pagrindus ir tai, ko jums reikia norint juos integruoti. Pažvelkite į tai, kaip prisijungti ir integruoti futbolo prognozavimo API iš „RapidAPI“ naudojant žemiau esantį „Python“.

Tai paprastas API iškvietimas, kuris pateikia JSON atsakymą. Taip pat galite parašyti savo kodą bet kokį teksto redaktoriųir paleiskite jį per komandinę eilutę.

Susijęs: Kaip paleisti „Python“ scenarijų

Tačiau atidžiai atkreipkite dėmesį į tikslą, užklausos antraštės ir atsakymo antraštės turinį:

importo užklausos
galutinis taškas = " https://football-prediction-api.p.rapidapi.com/api/v2/predictions"
queryparams = {"market": "classic", "iso_date": "2021-01-01", "federation": "UEFA"}
# Apibrėžkite užklausos antraštę:
antraštės = {
'x-rapidapi-key': "Čia įklijuokite savo prieigos raktą",
„x-rapidapi-host“: „football-prediction-api.p.rapidapi.com“
}
# Apibrėžkite atsakymo antraštę:
response = užklausos.request ("GET", galinis taškas, antraštės = antraštės, parametrai = užklausos parametrai)
#Gaukite atsakymą:
spausdinti (response.text)

Mokykis toliau: Kaip naudoti „IPStack“ API ieškant IP

Kaip gauti dabartinę vietos temperatūrą ir drėgmę naudojant „Weatherstack“ API su Python? Toliau pateiktas pavyzdys:

importo užklausos
galutinis taškas = ' http://api.weatherstack.com/current'
antraštės = {
"access_key": "Čia įklijuokite savo prieigos raktą",
"query": "Kalifornija"
}
req = užklausos.get (galinis taškas, antraštės)
res = req.json ()
spausdinti (u "Dabartinė temperatūra% s yra% d ℃"% 
(res ["vieta"] ["vardas"], res ["esama"] ["temperatūra"]))
spausdinti (u "Dabartinė drėgmė% s yra% d ℃"% 
(res ["location"] ["name"], res ["current"] ["drėgmė"]))

API tipai, kuriuos galite integruoti

Atvirojo kodo API yra nemokamos, jas gali naudoti visi. Vidinės API yra organizacijoje ir tik jai priklausančios programos gali naudoti jos išteklius.

Tačiau taip pat galite pasirinkti specialią API įvesdami partnerystės sutartį su teikėju. Arba galite sujungti keletą API, kad išspręstumėte įvairias problemas.

Be to, šios API, išskyrus atvirojo kodo ir vidines API, gali kainuoti, kartais svyruoja nuo šimtų iki tūkstančių dolerių.

Supaprastinkite programų kūrimą naudodami API

Kaip matote, jums nebereikia rašyti daug laiko reikalaujančio kodo. Jei jums reikalinga programa, kad atliktumėte sudėtingas operacijas, visada galite ieškoti ten ir patraukti atitinkamą API. Laimei, juos dabar netgi lengva integruoti nei senus įprastus. O jei jums įdomu ir norite sužinoti daugiau, yra daugybė nemokamų API, kurie gali padėti jums susitepti rankas.

Kaip veikia API ir kaip juos integruoti į jūsų programą

Taikomųjų programavimo sąsajų (API) naudojimas yra būtinas įgūdis, kurį turi įvaldyti visi programuotojai.

Skaitykite toliau

Apie autorių