Mit jelent az API? Példák az API-k használatára

Az API rövidítése az "Application Programming Interface". És bár ez furcsán hangozhat, ha még nem ismeri a programozást, könnyen megérthető, ha lebontja. Akár naponta használja őket mobiltelefonja, számítógépe vagy az internet böngészése közben.

A szoftverek, beleértve a webalkalmazásokat, mobilalkalmazásokat és sok más programot, összekapcsolják a világot az interneten keresztül. De ennek hatékonyabbá tételéhez kommunikációs csatornának kell lennie a szoftver között - ott jön be az API.

Itt elmagyarázzuk az API-k jelentését és használatát.

Mi az API?

Tudja, hogy képes videókat megtekinteni többek között olyan streaming platformokon, mint a Netflix vagy a YouTube? Ez azért lehetséges, mert API-n keresztül küld kérelmet.

Vagy elképzelte, hogyan képes fizetni azokért az árukért, amelyeket olyan online áruházakból vásárol, mint az Amazon vagy az eBay? Ennek oka az is, hogy van egy kommunikációs csatorna, amelyet API-ként ismerünk a bank és a vásárlási alkalmazások között.

Ez azt jelenti, hogy az API egy olyan szabályokkal rendelkező interfész, amely lehetővé teszi az alkalmazás szervere számára, hogy kölcsönhatásba lépjen a megoldásszolgáltató szerverével, így felhasználhatja az erőforrásaikat. Lényegében meghatározza, hogy az alkalmazások vagy szoftver hogyan kommunikál egymással.

Bizonyos esetekben azonban az API lehetővé teszi a kölcsönös adatcserét. Példa erre a kapcsolat a banki alkalmazások és az online áruház alkalmazásai között.

Az API olyan, mint egy messenger. Az egyik végén csatlakozik a szolgáltató szerveréhez, és a másik végén rögzíti az ügyfél szerverét is. Ezután felajánlja az ügyfél kérését az adatforrásnak (a szolgáltató szerverének), és választ ad vissza az ügyfélnek. A kliens itt a böngésző vagy az alkalmazás.

Egy horog azonban csatolja az alkalmazást az API-hoz. Ez egy API végpont. Sok minden azonban a színfalak mögött zajlik. Ezeket tovább elmagyarázzuk.

Hogyan segíthetnek az API-k az alkalmazások gyorsabb fejlesztésében

Az API-k intelligensebb eszközök a zökkenőmentes és robusztus alkalmazások felépítéséhez. Nélkülük a kifinomult alkalmazások építése korokat vesz igénybe.

Képzelje el, hogy komplex műveletek végrehajtásához szüksége van az alkalmazására, amely típus rengeteg időt és erőfeszítést igényel. És akkor megjelenik valaki egy kész programmal, amely pontosan azt csinálja, amit akar, és esetleg jobban is.

De hogyan lehet ezt összekapcsolni az alkalmazásával? A szolgáltató tudomásul veszi, hogy ez némi nehézséget okozhat Önnek, majd elmondta, hogy létrehoztak egy kapcsolódási felületet (API), amely a kódjukat és a tiéteket zökkenőmentesen integrálja.

Ez az interfész (API) csatlakozik a kódot tartalmazó kiszolgálóhoz. Ezután visszaküldi a releváns adatokat a szkript műveletéből.

Természetesen nem akarja unni magát a teljes forráskriptjükkel. Ezenkívül a legtöbb modern API mostantól a szabványosított REST (Representational State Transfer) technológiára támaszkodik. Ez nagymértékben skálázhatóvá és könnyen integrálhatóvá teszi őket, anélkül, hogy előformázáskor aggódnia kellene a válaszok vagy kéréseinek kibontakozása miatt, vagy a válasz vagy kérés állapota miatt.

Ez a cikk nem részletezi a REST API magyarázatát. Egyelőre az alapokra koncentráljon.

A kódot az övékbe dugni jobb ötlet, mint a semmiből írni. Ehhez azonban össze kell kapcsolnia a kódot az általuk biztosított API-val. Hogy csinálod ezt? Itt jön létre a jelenet egy API-végpont.

Mi az API végpont?

A dolgok egyszerűsítése érdekében a szolgáltatók ezt követően felállítottak egy URL-t, hogy zökkenőmentessé tegyék a kapcsolatot az API-val. Az ilyen URL egy API végpont. Ezzel az alkalmazás hozzáférhet a szerverükhöz az API-n keresztül, és közvetlenül kommunikálhat a szkriptjükkel.

Tehát csak annyit kell tennie, hogy megragadja a végpontot, beilleszti a kódba, kéréseket tesz vele, testre szabja a válaszokat, és ezután működik, és ez a tiéd! Az API-végpont ezért az API-t egy megoldáshoz vagy adatforráshoz köti.

Végül sok API-t kínáló program különféle programozási nyelveken érhető el, így senkit sem zárnak ki azok előnyei.

Így gyorsabban és hatékonyabban juthat hozzá a kódhoz, tudva, hogy az API karbantartása nem rajtad múlik, hanem az adatok vagy megoldások szolgáltatóin.

Ezért az API végpont egy kommunikációs kampó, amely az API-t az egyik szélén erőforrás-kiszolgálóhoz köti, a másik végén pedig a vevő szerveréhez köti.

Ez azt jelenti, hogy nincs szüksége a használni kívánt megoldás teljes szkriptjére. De a kód nem képes kapcsolatot létesíteni vele, ha nem csatlakozik az API végpontjához.

API integrációs szabályok

Nincs szigorú szabály az API integrálására. Rengeteg van odakint, és mindegyiknek megvannak az integrációs szabályai. De ne feledje, hogy a válasz amikor kapcsolatot létesít egy API-val.

Az API-végponton keresztüli kérelmek benyújtása általában a szolgáltató által meghatározott szabályok alapján történik, de az, hogy mit tesz a kapott válaszsal, az Ön preferenciájától függ. Lényegében úgy csavarhatja, ahogyan szeretné, hogy megfeleljen alkalmazásának felhasználói tapasztalatainak és felületének.

Előfordul, hogy az API eléréséhez hitelesítőre is szükség van. Az ilyen hitelesítők általában hozzáférési tokenekként vagy API kulcsokként érkeznek. Miután ez a token sikeresen átment egy hitelesítési teszten, az API jelzi a végpontját, hogy kapcsolatot létesítsen az alkalmazás és a szolgáltató szervere között.

API-fogyasztóként nem kell aggódnia ezekért a paraméterekért, mert az API-szolgáltató elérhetővé teszi őket. Egy nagyszerű API-nak azt is meg kell határoznia, hogy hogyan férhet hozzá és hogyan használhatja az erőforrásait a dokumentációjában. Tehát mindig figyeljen erre, amikor megpróbálja integrálni.

A kerekítéshez egy API hívás szól a fejlécek, an végpont, a kérés, és a válasz vagy a test.

Míg elmagyaráztuk, mi a végpont, bontsuk tovább ezeket a többi kifejezést:

Fejlécek

Általában két fejlécet kell leírnia az API-hoz való csatlakozás közben: a kérés és a válasz fejlécek.

A kérés fejléc az API-hívás átjárója. Leírja az ügyfél megközelítését az erőforrások eléréséhez. Részletesen leírhatja az elfogadható kapcsolattípust, a proxy információkat és az API-tól szerzett adattípust (JSON, XML vagy HTML).

Amint azt korábban leírtuk, attól függően, hogy milyen típusú API-hoz csatlakozik, előfordulhat, hogy a kérelem fejlécében is egyedi hitelesítési tokent kell megadnia. A szolgáltató általában ezt adja.

A válasz fejlécmásrészt a szolgáltató szerveréről érkező adatok állítása. Információt ad az alkalmazásnak a szolgáltató jellemzőiről. Lényegében biztosítja, hogy az alkalmazás hozzáférést biztosítson az API-ból érkező válaszhoz.

API kérés

Az API kérés általában a végpontot tartalmazza egy URL-ben (egyedi erőforrás-lokátor). A Hypertext Transfer Protocol (HTTP) segítségével keresse meg az erőforrás címét, amelyhez API-val próbál hozzáférni. Végül egy API-kérés nem teljes, ha nem tartalmazza a végpontot az URL-ben.

API válasz

Válasz az, amit az API visszaküld minden alkalommal, amikor kérést kap az alkalmazásától. Ez lehet JSON, XML vagy HTML, attól függően, hogy milyen adatokat vagy tartalomtípust kap a kérés fejlécétől.

Ha választ kap egy API-tól, akkor sikeresnek tekintheti az API-hívását.

Az API-k használata: gyakorlati példák

Most, hogy ismeri az API-k alapjait, és mi szükséges az egyik integrálásához. Vessen egy pillantást arra, hogyan lehet összekapcsolni és integrálni a futball-előrejelzési API-t RapidAPI lenti Python használatával.

Ez egy egyszerű API-hívás, amely JSON-választ ad vissza. Beírhatja a kódját is bármilyen szövegszerkesztő, és futtassa a parancssoron keresztül.

Összefüggő: A Python szkript futtatása

Nagyon figyeljen azonban a végpontra, a kérésfejlécek és a válaszfejlécek tartalmára:

importkérések
végpont = " https://football-prediction-api.p.rapidapi.com/api/v2/predictions"
queryparams = {"market": "classic", "iso_date": "2021-01-01", "federation": "UEFA"}
# Határozza meg a kérés fejlécét:
fejlécek = {
'x-rapidapi-key': "Illessze ide a hozzáférési kulcsot",
'x-rapidapi-host': "football-prediction-api.p.rapidapi.com"
}
#Define a válasz fejléc:
válasz = request.request ("GET", végpont, fejlécek = fejlécek, paraméterek = lekérdezo paraméterek)
# Szerezd meg a választ:
nyomtatás (response.text)

Tanulj tovább: Az IPStack API használata az IP földrajzi helykereséshez

Mit szólna hozzá, ha a hely aktuális hőmérsékletét és páratartalmát megkapná Weatherstack API a Pythonnal? Íme egy példa az alábbiakban:

importkérések
végpont = ' http://api.weatherstack.com/current'
fejlécek = {
"access_key": "Illessze ide a hozzáférési kulcsot",
"query": "Kalifornia"
}
req = request.get (végpont, fejlécek)
res = req.json ()
nyomtatás (u "Az aktuális hőmérséklet% s-ban% d ℃"% 
(res ["hely"] ["név"], res ["aktuális"] ["hőmérséklet"]))
nyomtatás (u "A jelenlegi páratartalom% s-ban% d ℃"% 
(res ["hely"] ["név"], res ["aktuális"] ["páratartalom"]))

Integrálható API-k típusai

A nyílt forráskódú API-k ingyenesek, és bárki használhatja őket. A belső API-k egy szervezeten belül találhatók, és csak a szervezethez tartozó alkalmazások használhatják az erőforrásait.

Választhat egy dedikált API-t is, ha partnerségi megállapodást köt a szolgáltatóval. Vagy kombinálhat több API-t különböző problémák megoldására.

Ezeknek az API-knak, a nyílt forráskódú és a belső API-kat leszámítva, ára lehet, néha száz dollártól ezer dollárig terjedhet.

Egyszerűsítse az alkalmazásfejlesztést az API-k segítségével

Mint láthatja, már nem kell időigényes kódot írni. Ha összetett műveletek végrehajtásához van szüksége az alkalmazására, akkor mindig ott kereshet, és megragadhat egy megfelelő API-t. Szerencsére most már könnyen integrálhatók, mint a régi hagyományosak. És ha kíváncsi vagy, és többet akarsz megtudni, sok ingyenes API létezik, amelyek segíthetnek a kezed bepiszkításában.

Az API-k működése és integrálása az alkalmazásba

Az alkalmazás-programozási felületek (API) használata elengedhetetlen ismeret minden programozó számára.

Olvassa el a következőt

A szerzőről