Mida API tähistab? API-de kasutamise näited

API tähistab "Application Programming Interface". Ja kuigi see võib tunduda kummaline, kui olete programmeerimises alles uus, on neid pärast jaotamist lihtne mõista. Kasutate neid isegi igapäevaselt oma mobiiltelefoni, arvuti või Interneti sirvimise ajal.

Tarkvara, sealhulgas veebirakendused, mobiilirakendused ja paljud muud programmid, seovad maailma Interneti kaudu. Kuid selle tõhusamaks muutmiseks peab selle tarkvara vahel olema sidekanal - sinna tuleb sisse API.

Siit selgitame API-de tähendust ja nende kasutamist.

Mis on API?

Kas teate, kuidas näete videoid teiste hulgas voogesitusplatvormidel nagu Netflix ja YouTube? See on võimalik, kuna saadate päringu API kaudu.

Või olete ette kujutanud, kuidas suudate maksta selliste kaupade eest, mida ostate veebipoodidest, nagu Amazon ja eBay? Seda ka seetõttu, et teie panga ja osturakenduste vahel on suhtluskanal, mida nimetatakse API-ks.

See tähendab, et API on liides reeglitega, mis võimaldavad teie rakenduse serveril suhelda lahenduste pakkuja serveriga, et saaksite nende ressursse kasutada. Sisuliselt määratleb see, kuidas rakendused või tarkvara omavahel suhtlevad.

Mõnel juhul võimaldab API siiski vastastikust andmevahetust. Näitena võib tuua teie pangarakenduste ja veebipoe rakenduste vahelise ühenduse.

API on nagu sõnumitooja. See ühendub ühes otsas teenusepakkuja serveriga ja kinnitab ka kliendi serveri teise otsa. Seejärel teeb ta pakkumise kliendi päringule andmeallikale (teenusepakkuja server) ja tagastab kliendile vastuse. Klient on siin brauser või teie rakendus.

Konks kinnitab teie rakenduse aga API-ga. See on API lõpp-punkt. Kuid paljud asjad arenevad sündmuskoha taga. Selgitame neid edasi.

Kuidas API-d aitavad teil rakendusi kiiremini arendada

API-d on nutikam tööriist sujuvate ja kindlate rakenduste loomiseks. Ilma nendeta võtaks keerukate äppide loomine aega.

Kujutage ette, et vajate oma rakendust keerukate toimingute tegemiseks, seda tüüpi ehitamiseks kulub palju aega ja vaeva. Ja siis ilmub keegi valmisprogrammiga, mis teeb täpselt seda, mida soovite, ja võib-olla ka paremini.

Aga kuidas saate selle oma rakendusega ühendada? Pakkuja mõistis, et see võib teile veidi aega anda, ja ütles siis, et nad lõid ühenduse liidese (API), mis paneb nende koodi ja teie sujuvalt integreeruma.

See liides (API) ühendub nende koodi sisaldava serveriga. Seejärel annab see teile tagasi asjakohased andmed nende skripti toimingust.

Muidugi ei taha te kogu nende lähtekoodiga end igavaks teha. Pealegi tugineb enamik tänapäevaseid API-sid nüüd standardiseeritud REST (Representational State Transfer) tehnoloogiale. See muudab need väga skaleeritavaks ja hõlpsasti integreeritavaks, ilma et peaksite muretsema selle pärast, mis teie eelvormindamisel teie vastus või taotlus toimub, või oleku pärast.

Selles artiklis REST API-d rohkem ei selgitata. Keskenduge praegu põhitõdedele.

Koodi ühendamine nende oma on parem mõte kui nullist kirjutamine. Selleks peate siiski oma koodi ühendama nende pakutava API-ga. Kuidas seda teha? Seal tuleb stseeni API lõpp-punkt.

Mis on API lõpp-punkt?

Asjade lihtsustamiseks panid pakkujad seejärel üles URL-i, et muuta nende API-ga ühendamine sujuvaks. Selline URL on API lõpp-punkt. Selle abil saab teie rakendus API kaudu oma serverile juurde pääseda ja oma skriptiga otse suhelda.

Nii et kõik, mida peate tegema, on haarata lõpp-punkt, kleepida see oma koodi, esitada sellega päringuid, kohandada vastuseid ja siis see töötab ja see on teie! Seetõttu seob API lõpp-punkt teie rakenduse API kaudu lahenduse või andmeallikaga.

Lõppkokkuvõttes on paljud API-sid pakkuvad programmid saadaval erinevates programmeerimiskeeltes, nii et keegi ei jääks nendest kasu saamast.

Nii saate kiiremini ja tõhusamalt koodi kodeerida, teades, et API säilitamise kohustus pole teie, vaid andmete või lahenduste pakkujate ülesanne.

Seetõttu on API lõpp-punkt sidekonks, mis seob API ühes servas ressursiserveriga ja ühendab selle teises otsas oleva vastuvõtja serveriga.

See tähendab siis, et te ei vaja kogu lahenduse skripti, mida soovite kasutada. Kuid teie kood ei saa sellega ühendust luua, kui see ei ühendu oma API lõpp-punktiga.

API integreerimise reeglid

API integreerimiseks pole ranget reeglit. Neid on seal tonni ja igaühel neist on oma integratsioonireeglid. Kuid pidage meeles, et ootate a vastus alati, kui loote ühenduse API-ga.

API-lõpp-punkti kaudu taotluste esitamine põhineb tavaliselt pakkuja määratletud reeglitel, kuid see, mida saate saadud vastusega, sõltub teie eelistustest. Sisuliselt saate seda väänata nii, nagu soovite, et see vastaks teie rakenduse kasutajate kogemustele ja liidesele.

Mõnikord vajate API-le juurde pääsemiseks ka autentijat. Sellised autentijad tulevad tavaliselt juurdepääsulubade või API-võtmetena. Kui see luba läbib autentimistesti, annab API seejärel oma lõpp-punktile märku ühenduse loomiseks teie rakenduse ja pakkuja serveri vahel.

API-tarbijana ei pea te nende parameetrite pärast muretsema, sest API-pakkuja teeb need kättesaadavaks. Suurepärane API peaks ka märkima, kuidas saate selle dokumentides oma ressurssidele juurde pääseda ja neid kasutada. Nii et pöörake alati tähelepanu sellele, kui proovite ühte integreerida.

Selle ümardamiseks on API-kõne kõik see päised, an lõpp-punkt, taotlus, ja vastus või keha.

Kuigi me oleme selgitanud, mis on tulemus, jagame need muud terminid veelgi:

Päised

Tavaliselt peate API-ga ühenduse loomisel kirjeldama kahte vormi päiseid: taotlus ja vastus päised.

The päringu päis on API kõne lüüs. See kirjeldab kliendi lähenemist ressursile juurdepääsemisel. See võib üksikasjalikult kirjeldada näiteks vastuvõetavat ühenduse tüüpi, puhverserveri teavet ja andmetüüpi (JSON, XML või HTML), mille soovite API-lt hankida.

Nagu me varem kirjeldasime, peate võib-olla esitama ainulaadse autentimismärgi ka päringu päises, sõltuvalt sellest, millise API-ga te ühenduse loote. Pakkuja tavaliselt annab selle.

The vastuse päis, teiselt poolt, on väide andmete kohta, mis pärinevad pakkuja serverist. See annab teie rakendusele teavet pakkuja omaduste kohta. Sisuliselt tagab see, et teie rakendus annab juurdepääsu API-lt pärinevale vastusele.

API taotlus

API taotlus sisaldab tavaliselt lõpp-punkti URL-is (ainulaadne ressursside otsija). Ta kasutab hüpertekstiedastusprotokolli (HTTP), et leida ressursi aadress, millele soovite API-ga juurde pääseda. Lõppkokkuvõttes pole API-taotlus täielik, kui te ei sisalda lõpp-punkti URL-is.

API vastus

Vastus on see, mida API saadab tagasi iga kord, kui saab teie rakendusest päringu. See võib olla JSON, XML või HTML, olenevalt teie päringu päisest saadud andmetest või sisutüübist.

Kui olete API-lt vastuse saanud, võite oma API-kõnet pidada edukaks.

API-de kasutamine: praktilised näited

Nüüd, kui teate API-de põhitõdesid ja mida peate selle integreerima. Vaadake, kuidas ühendada ja integreerida jalgpalli prognoosimise API RapidAPI kasutades allpool Pythoni.

See on lihtne API-kõne, mis tagastab JSON-vastuse. Samuti saate oma koodi sisse kirjutada mis tahes tekstiredaktorja käivitage see käsurea kaudu.

Seotud: Kuidas Pythoni skripti käivitada

Pöörake siiski tähelepanelikult lõpp-punkti, päringu päiste ja vastuse päiste sisu:

imporditaotlused
lõpp-punkt = " https://football-prediction-api.p.rapidapi.com/api/v2/predictions"
queryparams = {"market": "classic", "iso_date": "2021-01-01", "federation": "UEFA"}
#Define päise päis:
päised = {
'x-rapidapi-key': "Kleebi oma pääsuvõti siia",
"x-rapidapi-host": "football-prediction-api.p.rapidapi.com"
}
#Define vastuse päis:
vastus = taotlused.request ("GET", lõpp-punkt, päised = päised, paramid = päringuparameetrid)
#Hangi vastus:
print (response.text)

Õpi edasi: Kuidas kasutada IPStacki API-d IP-geograafilise asukoha otsimisel

Kuidas oleks saada koha praegust temperatuuri ja niiskust Weatherstacki API Pythoniga? Siin on näide allpool:

imporditaotlused
lõpp-punkt = ' http://api.weatherstack.com/current'
päised = {
"access_key": "Kleepige oma pääsuvõti siia",
"query": "California"
}
req = taotlused.get (lõpp-punkt, päised)
res = req.json ()
print (u "Praegune temperatuur% s on% d ℃"% 
(res ["asukoht"] ["nimi"], res ["praegune"] ["temperatuur"]))
print (u "Praegune niiskus% s on% d ℃"% 
(res ["asukoht"] ["nimi"], res ["praegune"] ["niiskus"]))

Integreeritavate API-de tüübid

Avatud lähtekoodiga API-d on tasuta ja kõik saavad neid kasutada. Sisemised API-d asuvad organisatsioonis ja selle ressursse saavad kasutada ainult sellele organisatsioonile kuuluvad rakendused.

Kuid saate valida ka spetsiaalse API, sisestades pakkujaga partnerluslepingu. Või võite erinevate probleemide lahendamiseks kombineerida mitu API-d.

Samuti võivad need API-d, välja arvatud avatud lähtekoodiga ja sisemised API-d, olla hinnaga, ulatudes mõnikord sadadest tuhandetesse dollaritesse.

Rakenduste arendamise lihtsustamine API-de abil

Nagu näete, pole vaja enam aeganõudvat koodi kirjutada. Kui vajate oma rakendust keerukate toimingute tegemiseks, saate alati sealt otsida ja haarata asjakohase API. Õnneks on neid nüüd isegi lihtne integreerida kui vanu tavapäraseid. Ja kui olete uudishimulik ja soovite rohkem teada saada, on seal palju tasuta API-sid, mis aitavad teil käsi määrduda.

Kuidas API-d töötavad ja kuidas neid oma rakendusse integreerida

Rakenduse programmeerimisliideste (API) kasutamine on kõigi programmeerijate jaoks oluline oskus.

Loe edasi

Autori kohta