Ko nozīmē API? Piemēri, kā izmantot API

API nozīmē "Lietojumprogrammu saskarne". Un, lai gan tas var likties dīvaini, ja jūs esat jauns programmētājs, tos ir viegli saprast, kad jūs to sadalāt. Jūs tos pat lietojat katru dienu, darbojoties ar mobilo tālruni, datoru vai pārlūkojot internetu.

Programmatūra, tostarp tīmekļa lietotnes, mobilās lietotnes un daudzas citas programmas, saista pasauli, izmantojot internetu. Bet, lai to padarītu efektīvāku, starp šo programmatūru ir jābūt sakaru kanālam - tur ienāk API.

Šeit mēs izskaidrosim API nozīmi un to izmantošanu.

Kas ir API?

Vai zināt, kā jūs varat redzēt videoklipus straumēšanas platformās, piemēram, Netflix un YouTube, cita starpā? Tas ir iespējams, jo jūs sūtāt pieprasījumu, izmantojot API.

Vai arī jūs esat iedomājies, kā jūs varat maksāt par precēm, kuras pērkat no tādiem tiešsaistes veikaliem kā Amazon un eBay? Tas ir arī tāpēc, ka starp jūsu banku un iepirkšanās lietotnēm ir saziņas kanāls, kas pazīstams kā API.

Tas nozīmē, ka API ir saskarne ar noteikumu kopumu, kas ļauj jūsu lietotnes serverim mijiedarboties ar risinājumu nodrošinātāja serveri, lai jūs varētu izmantot viņu resursus. Būtībā tas nosaka, kā lietotnes vai programmatūra sazinās savā starpā.

Dažos gadījumos API tomēr ļauj veikt savstarpēju datu apmaiņu. Piemērs ir savienojums, kas pastāv starp jūsu bankas lietotnēm un tiešsaistes veikalu lietotnēm.

API ir kā kurjers. Vienā galā tas izveido savienojumu ar pakalpojumu sniedzēja serveri un noenkuro klienta serveri arī otrā galā. Pēc tam tā nosūta klienta pieprasījumu datu avotam (pakalpojumu sniedzēja serverim) un klientam atgriež atbildi. Klients šeit ir pārlūkprogramma vai jūsu lietotne.

Āķis tomēr pievieno jūsu lietotni API. Tas ir API galapunkts. Tomēr daudz kas notiek aiz ainas. Mēs tos paskaidrosim tālāk.

Kā API palīdz ātrāk izstrādāt lietotnes

API ir viedāks rīks nevainojamu un stabilu lietojumprogrammu veidošanai. Bez tiem sarežģītu lietotņu veidošana prasītu vecumu.

Iedomājieties, ka jūsu lietotne ir nepieciešama sarežģītu darbību veikšanai, tāda veida izveidošanai nepieciešams daudz laika un pūļu. Un tad kāds parādās ar gatavu programmu, kas dara tieši to, ko vēlaties, un, iespējams, arī labāk.

Bet kā jūs varat to savienot ar savu lietotni? Pakalpojuma sniedzējs, saprotot, ka tas var sagādāt jums zināmu laiku, pēc tam teica, ka ir izveidojis savienojuma saskarni (API), kas ļauj viņu un jūsu kodam integrēties nevainojami.

Šī saskarne (API) izveido savienojumu ar serveri, kurā ir viņu kods. Tad tas sniedz jums atpakaļ attiecīgos datus no viņu skripta darbības.

Protams, jūs nevēlaties sevi apnikt ar visu viņu avota skriptu. Turklāt lielākā daļa mūsdienu API tagad balstās uz standartizētu REST (Representational State Transfer) tehnoloģiju. Tas padara tos ļoti pielāgojamus un viegli integrējamus, jums nav jāuztraucas par to, kas notiek jūsu atbildes laikā vai pieprasījuma stāvokli, kad tie ir iepriekš formatēti.

Šajā rakstā netiks sīkāk izskaidrota REST API. Pagaidām koncentrējieties uz pamatiem.

Koda pievienošana viņu rīcībā ir labāka ideja nekā tā rakstīšana no nulles. Lai to izdarītu, jums ir jāpievieno kods ar API, kuru viņi ir nodrošinājuši. Kā jūs to darāt? Tieši tajā vietā parādās API galapunkts.

Kas ir API galapunkts?

Lai vienkāršotu lietas, pakalpojumu sniedzēji pēc tam izveidoja vietrādi URL, lai savienojums ar viņu API būtu vienmērīgs. Šāds URL ir API galapunkts. Izmantojot to, jūsu lietotne pēc tam var piekļūt savam serverim, izmantojot API, un tieši sazināties ar skriptu.

Tāpēc viss, kas jums jādara, ir paķert galapunktu, ielīmēt to savā kodā, veikt pieprasījumus ar to, pielāgot atbildes, un tad tas darbojas, un tas ir jūsu! Tāpēc API galapunkts saista jūsu lietotni, izmantojot API, ar risinājumu vai datu avotu.

Galu galā daudzas no programmām, kas piedāvā API, ir pieejamas dažādās programmēšanas valodās, lai neviens netiktu izslēgts no tām.

Tādā veidā jūs ātrāk un efektīvāk kodējat, zinot, ka API uzturēšanas pienākums nav jums, bet gan datu vai risinājumu nodrošinātājiem.

Tāpēc API galapunkts ir sakaru āķis, kas vienā malā saista API ar resursu serveri un otrā galā savieno to ar uztvērēja serveri.

Tad tas nozīmē, ka jums nav nepieciešams viss izmantotā risinājuma skripts. Bet jūsu kods nevar izveidot sakarus ar to, ja tas neizveido savienojumu ar tā API galapunktu.

API integrācijas noteikumi

API integrēšanai nav stingru noteikumu. Viņu tur ir daudz, un katram no tiem ir savi integrācijas noteikumi. Bet ņemiet vērā, ka jūs sagaidāt atbildi ikreiz, kad izveidojat savienojumu ar API.

Tas, kā jūs iesniedzat pieprasījumus, izmantojot API galapunktu, parasti balstās uz pakalpojumu sniedzēja definētiem noteikumiem, taču tas, ko jūs darāt ar saņemto atbildi, ir atkarīgs no jūsu vēlmēm. Būtībā jūs varat to pagriezt, kā vēlaties, lai tas atbilstu jūsu lietotnes lietotāju pieredzei un saskarnei.

Dažreiz pirms piekļuves API jums ir nepieciešams arī autentifikators. Šādi autentifikatori parasti nāk kā piekļuves marķieri vai API atslēgas. Kad šī pilnvara iztur autentifikācijas pārbaudi, API pēc tam signalizē par savu gala punktu, lai izveidotu savienojumu starp jūsu lietotni un nodrošinātāju serveri.

Kā API patērētājam jums nav jāuztraucas par šiem parametriem, jo ​​API nodrošinātājs tos padara pieejamus. Lieliskai API vajadzētu arī norādīt, kā dokumentācijā varat piekļūt un izmantot tās resursus. Tāpēc vienmēr uzmanieties, mēģinot to integrēt.

Lai to noapaļotu uz augšu, API zvans ir par visu galvenes, an galapunkts, pieprasījumuun atbildi vai ķermeņa.

Lai gan mēs esam izskaidrojuši, kas ir galapunkts, sīkāk sadalīsim šos citus nosacījumus:

Galvenes

Parasti, veidojot savienojumu ar API, jums jāapraksta divas galvenes formas: pieprasījumu un atbildi galvenes.

The pieprasījuma galvene ir API izsaukuma vārteja. Tas apraksta klienta pieeju piekļuvei resursam. Tas varētu detalizēti aprakstīt tādas lietas kā pieņemams savienojuma veids, starpniekservera informācija un datu tips (JSON, XML vai HTML), kuru vēlaties iegūt no API.

Kā mēs aprakstījām iepriekš, atkarībā no API veida, ar kuru savienojat, iespējams, pieprasījuma galvenē, iespējams, būs jānorāda arī unikāls autentifikācijas marķieris. Pakalpojuma sniedzējs parasti to dod.

The atbildes galvene, no otras puses, ir apgalvojums par datiem, kas nāk no pakalpojumu sniedzēja servera. Tas sniedz jūsu lietotnei informāciju par pakalpojumu sniedzēja īpašībām. Būtībā tas nodrošina, ka jūsu lietotne piešķir piekļuvi atbildei, kas nāk no API.

API pieprasījums

API pieprasījumā URL parasti ir unikāls resursu meklētājs (URL). Tas izmanto hiperteksta pārsūtīšanas protokolu (HTTP), lai atrastu tā resursa adresi, kuram mēģināt piekļūt, izmantojot API. Galu galā API pieprasījums nav pilnīgs, ja URL neiekļaujat galapunktu.

API atbilde

Atbilde ir tā, ko API sūta katru reizi, kad saņem pieprasījumu no jūsu lietotnes. Tas var būt JSON, XML vai HTML, atkarībā no datu vai satura veida, ko tas saņem no pieprasījuma galvenes.

Kad esat saņēmis atbildi no API, varat uzskatīt, ka jūsu API izsaukums ir veiksmīgs.

Kā izmantot API: praktiski piemēri

Tagad, kad jūs zināt API pamatus un to, kas jums ir nepieciešams, lai to integrētu. Apskatiet, kā izveidot un integrēt futbola prognožu API no RapidAPI izmantojot Python zemāk.

Tas ir vienkāršs API izsaukums, kas atgriež JSON atbildi. Varat arī ierakstīt kodu jebkuru teksta redaktoruun palaidiet to, izmantojot komandrindu.

Saistīts: Kā palaist jūsu Python skriptu

Tomēr pievērsiet īpašu uzmanību galamērķim, pieprasījuma galvenes un atbildes galvenes saturam:

importa pieprasījumi
galapunkts = " https://football-prediction-api.p.rapidapi.com/api/v2/predictions"
queryparams = {"market": "classic", "iso_date": "2021-01-01", "federation": "UEFA"}
# Definējiet pieprasījuma galveni:
galvenes = {
'x-rapidapi-key': "Šeit ielīmējiet piekļuves atslēgu",
"x-rapidapi-host": "football-prediction-api.p.rapidapi.com"
}
# Definējiet atbildes galveni:
atbilde = pieprasījumi.request ("GET", gala punkts, galvenes = galvenes, parametri = vaicājuma parametri)
#Iegūstiet atbildi:
drukāt (response.text)

Turpiniet mācīties: Kā izmantot IPStack API IP ģeogrāfiskās atrašanās vietas meklēšanai

Kā par vietas pašreizējās temperatūras un mitruma iegūšanu, izmantojot Weatherstack API ar Python? Tālāk ir sniegts piemērs:

importa pieprasījumi
galapunkts = ' http://api.weatherstack.com/current'
galvenes = {
"access_key": "Šeit ielīmējiet piekļuves atslēgu",
"query": "Kalifornija"
}
req = pieprasījumi.get (galapunkts, galvenes)
res = req.json ()
drukāt (u "Pašreizējā temperatūra% s ir% d ℃"% 
(res ["atrašanās vieta"] ["nosaukums"], res ["pašreizējais"] ["temperatūra"]))
drukāt (u "Pašreizējais mitrums% s ir% d ℃"% 
(res ["atrašanās vieta"] ["nosaukums"], res ["pašreizējais"] ["mitrums"]))

API veidi, kurus varat integrēt

Atvērtā koda API ir bezmaksas, un ikviens tos var izmantot. Iekšējās API atrodas organizācijā, un tās resursus var izmantot tikai šai organizācijai piederošās lietotnes.

Tomēr jūs varat arī izvēlēties īpašu API, noslēdzot partnerības līgumu ar pakalpojumu sniedzēju. Vai arī varat apvienot vairākus API dažādu problēmu risināšanai.

Arī šīm API, izņemot atvērtā koda un iekšējās API, varētu būt cena, dažkārt svārstoties no simtiem līdz tūkstošiem dolāru.

Vienkāršojiet lietotņu izstrādi, izmantojot API

Kā redzat, jums vairs nav jāraksta laikietilpīgs kods. Ja jums ir vajadzīga jūsu lietotne, lai veiktu sarežģītas darbības, jūs vienmēr varat meklēt tur un paķert atbilstošo API. Par laimi, tos tagad ir pat viegli integrēt nekā vecos parastos. Un, ja jūs esat ziņkārīgs un vēlaties uzzināt vairāk, tur ir daudz bezmaksas API, kas var palīdzēt jums sasmērēt rokas.

Kā darbojas API un kā tos integrēt savā lietotnē

Lietojumprogrammu saskarņu (API) izmantošana ir būtiska prasme, ko apgūt visi programmētāji.

Lasiet Tālāk

Par autoru