Nem, az API nem az Apple Pie Inside-t jelenti. ?? Az API az Application Programming Interface rövidítést jelenti. Az API-k lehetővé teszik, hogy két alkalmazás kapcsolódjon (vagy kölcsönhatásba lépjen) egymással.
API egy programozási utasítások és funkciók összessége, amelyeket egy weboldal vagy webalapú szoftveralkalmazás elérésére használnak. Az API lehetővé teszi más fejlesztők számára az alkalmazás adatainak és funkcióinak használatát. Ez lehetővé teszi, hogy a termék kölcsönhatásba lépjen más termékekkel.
Az API-kat először az 1980-as években használták a szoftver- és hardverfejlesztésben. De most, amikor az emberek API-król beszélnek, általában webes API-kra, pontosabban RESTful API-kra hivatkoznak. Általánossá vált a RESTful API-k használata webalapú alkalmazások fejlesztésekor.
A webes API alapvetően egy olyan program, amellyel teljesen URL-eken keresztül kommunikál. Normális esetben, amikor a böngészővel URL-re küld egy kérést, a szerver visszaküldi a megjelenő választ, amelyet megnézhet. Más a helyzet, ha kérést küld egy API URL-jére. A szerver visszaküld valamit, ami csak a számítógép számára hasznos. Az API olyan adatokat ad vissza, amelyek felhasználhatók egy másik webhelyen vagy programban.
Mire használják az API-kat?
Az API-kat nem a végfelhasználó használja. Arra használják, hogy a szoftverek kölcsönhatásba lépjenek más szoftverekkel. Például egy weboldal felhívhatja az Open Weather API-t, hogy időjárási információkat jelenítsen meg a webhelyen.
Az API-kat néha egyetlen vállalaton belül is használják. Használhatók belső weboldalak és rendszerek létrehozására, amelyek könnyen kölcsönhatásba lépnek egymással.
Hogyan működik az API?
Az API általában hozzáférést biztosít másoknak nagy mennyiségű szervezett adathoz. Ezen adatok kapuvédője engedélyt ad egy fejlesztőnek ( API kulcs formájában ), hogy információkat kérjen a szervertől. Ha a kérés sikeres, a szerver üzenettel válaszol, általában JSON vagy XML formátumban.
Általában dokumentáció áll rendelkezésre a használni kívánt API számára, az úgynevezett API specifikáció. Ez elmagyarázza a vezérlőket és az API használatát.
Íme egy példa az API specifikációjára az OpenWeather API számára, amely lehetővé teszi az aktuális időjárás elérését egy adott helyen: //openweathermap.org/current
Az API specifikációk tartalmazzák az URL-ek listáját, amelyek segítségével adatokat nyerhet. Az egyik URL használatát API kérésnek vagy API hívásnak nevezzük . A specifikáció gyakran megmutatja a paramétereket és a választ minden egyes URL-hez, amely az API része.
Paraméterek
A paraméterek azok, amelyeket hozzáad az URL végéhez annak meghatározásához, hogy az API-t milyen információkkal szeretné visszaadni. A paraméterek alapvetően változók, amelyeket átad az API-nak.
Az időjárási információk lekérésére szolgáló URL az OpenWeather API-tól:
api.openweathermap.org/data/2.5/weather.
Hozzá kell adni egy várost mint paramétert annak megadásához, hogy melyik helyre adja vissza az időjárási adatokat. Itt van az URL a város paraméterével:
api.openweathermap.org/data/2.5/weather?q=London
Néha paraméterekre van szükség a válasz eléréséhez. Néha a paraméterek nem kötelezőek. Az OpenWeather API-ban meg kell adni egy helyet, de a városnéven kívül más módon is megadhatja a helyet. Az összes módszert megadja az API specifikáció.
A paraméterek a következőket is meghatározhatják:
- Hogyan kell az eredményeket rendezni?
- Hány eredményt kell visszaküldeni?
- Milyen formátumúak legyenek az eredmények?
- Milyen dátumtartományban szeretne eredményeket elérni?
A válasz
Amikor kérést küld egy API-nak, akkor válaszot kap. Vagy visszakapja a kért adatokat, vagy annak okát, hogy miért nem sikerült a kérés.
Az alábbiakban egy példa a választ kapsz, ha elküldi a következő kérés: api.openweathermap.org/data/2.5/weather?q=London. Ez egy JSON válasz.
{ "coord": { "lon": -0.13, "lat": 51.51 }, "weather": [ { "id": 300, "main": "Drizzle", "description": "light intensity drizzle", "icon": "09d" } ], "base": "stations", "main": { "temp": 280.32, "pressure": 1012, "humidity": 81, "temp_min": 279.15, "temp_max": 281.15 }, "visibility": 10000, "wind": { "speed": 4.1, "deg": 80 }, "clouds": { "all": 90 }, "dt": 1485789600, "sys": { "type": 1, "id": 5091, "message": 0.0103, "country": "GB", "sunrise": 1485762037, "sunset": 1485794875 }, "id": 2643743, "name": "London", "cod": 200 }Előfordulhat, hogy az API-válasz nem ilyen formátumú, mint ez a példa. Az egész szöveg gyakran egy sorban található. Mivel főleg számítógép és nem személy által olvasható, a formázás nem számít.
API kulcsok
Ha maga próbálja ki a fenti URL-t, akkor nem kapja meg a fenti választ. Valószínűleg jobban fog kinézni:
{ "cod": 401, "message": "Invalid API key. Please see //openweathermap.org/faq#error401 for more info." }Az API-k többsége valamilyen hitelesítést igényel, mielőtt visszaadná az adatokat. Ez általában API kulcs formájában történik . Ezek a kulcsok olyanok, mint egy jelszó. Ezek hosszú betűk és számok, amelyeket el kell küldenie az API-kérelmével, hogy a szerver tudja, hogy hozzáférhet az információkhoz.
Az OpenWeather API-hoz és sok más API-hoz egy fiók létrehozása után ingyen beszerezhet egy API-kulcsot. Számos vállalat az API-kulcsokat használja az ingyenes API-kon, hogy megbizonyosodjon arról, hogy az emberek nem sok kérelmet nyújtanak be egy nap alatt. Valóban elakadhat egy szerver, ha egyetlen ember percenként több ezer kérést küldene.
Egyes API-k API kulcs nélkül nyilvánosak. Az alábbiakban egy olyan API található, amely rímelő szavakat keres. Kattintson a linkre, majd próbálja meg megváltoztatni az utolsó szót az URL-ben különböző rímelő szavak keresésére.
//api.datamuse.com/words?rel_rhy=camp
Szeretne többet megtudni?
Ha többet szeretne megtudni az API-k használatáról, nézze meg az alábbi videót a freeCodeCamp.org YouTube csatornán.