Mida API tähistab? Kodeeriva akronüümi määratlus tavalises inglise keeles.

Ei, API ei tähenda Apple Pie Inside. ?? API tähistab rakenduse programmeerimisliidest. API-d võimaldavad kahel rakendusel üksteisega liidestada (või suhelda).

API - komplekt programmeerimisjuhiseid ja funktsioone, mida kasutatakse veebisaidile või veebipõhisele tarkvararakendusele juurdepääsemiseks. API võimaldab teistel arendajatel kasutada teie rakenduse andmeid ja funktsionaalsust. See võimaldab teie tootel suhelda teiste toodetega.

API-sid hakati tarkvara ja riistvara arendamisel kasutama 1980. aastatel. Kuid nüüd, kui inimesed räägivad API-dest, viitavad nad tavaliselt veebi API-dele või täpsemalt RESTful API-dele. Veebipõhiste rakenduste väljatöötamisel on tavaks saanud RESTful API-de kasutamine.

Veebiliides on põhimõtteliselt programm, millega suhtlete täielikult URL-ide kaudu. Tavaliselt, kui saadate oma brauseriga URL-ile päringu, saadab server tagasi vastuse, mis kuvatakse teile vaatamiseks. Asjad on erinevad, kui saadate päringu API URL-ile. Server saadab tagasi midagi, mis on mõeldud ainult arvutile. API tagastab andmed, mida saab kasutada muul veebisaidil või programmis.

Milleks API-sid kasutatakse?

API-d ei ole mõeldud lõppkasutaja jaoks kasutamiseks. Neid kasutatakse tarkvara suhtlemiseks muu tarkvaraga. Näiteks võib veebisait helistada Open Weather API-le, et saada ilmateavet veebisaidil kuvamiseks.

API-sid kasutatakse mõnikord ka ühe ettevõtte sees. Nende abil saab luua sisemisi veebisaite ja süsteeme, mis suhtlevad üksteisega lihtsalt.

Kuidas API töötab?

API annab teistele üldjuhul juurdepääsu suurele hulgale korrastatud andmetele. Nende andmete väravavaht annab arendajale loa ( API võtme kujul ) serverilt teabe küsimiseks. Kui taotlus on edukas, vastab server sõnumiga, tavaliselt JSON- või XML-vormingus.

Tavaliselt on olemas dokumentatsioon API kohta, mida soovite kasutada, nimega API spetsifikatsioon. See selgitab juhtnuppe ja API kasutamist.

Siin on näide OpenWeatheri API API spetsifikatsioonist, mis võimaldab teil praegusest ilmast teatavas kohas saada: //openweathermap.org/current

API spetsifikatsioonid sisaldavad URL-ide loendit, mida saate andmete hankimiseks kasutada. Ühe URL-i kasutamist nimetatakse API-päringuks või API-kõneks . Sageli kuvatakse spetsifikatsioonis parameetrid ja vastus iga URL-i jaoks, mis on API osa.

Parameetrid

Parameetrid on need, mida lisate URL-i lõppu, et määrata, millist teavet soovite API-le tagastada. Parameetrid on põhimõtteliselt muutujad, mille edastate API-le.

Ilmateabe saamiseks OpenWeatheri API-st on URL:

api.openweathermap.org/data/2.5/weather.

Siiski peate lisama parameetriks linna, et määrata, millise asukoha kohta ilmateate tagastatakse. Siin on linna parameetriga URL:

api.openweathermap.org/data/2.5/weather?q=London

Mõnikord on vastuse saamiseks vaja parameetreid. Mõnikord on parameetrid valikulised. OpenWeather API-s on nõutav asukoha sisestamine, kuid lisaks linna nimele on asukoha määramiseks ka muid võimalusi. Kõik viisid on toodud API spetsifikatsioonis.

Parameetritega saab määrata ka näiteks:

  • Kuidas tuleks tulemusi sortida?
  • Kui palju tulemusi tuleks tagastada?
  • Mis formaadis tulemused peaksid olema?
  • Mis kuupäevavahemiku tulemusi soovite?

Vastus

Kui saadate API-le päringu, saate vastuse tagasi. Saate kas soovitud andmed tagasi või põhjuse, miks taotlus ebaõnnestus.

Allpool on näide vastuse saad, kui saadad järgmise taotluse: api.openweathermap.org/data/2.5/weather?q=London. See on JSONi vastus.

{ "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 }

API vastus ei pruugi olla vormistatud nagu see näide. Kogu tekst on sageli ühel real. Kuna see on mõeldud peamiselt arvuti ja mitte inimese lugemiseks, pole vormindus oluline.

API võtmed

Kui proovite ülaltoodud URL-i ise, ei saa te ülaltoodud vastust. Tõenäoliselt näeb see välja järgmine:

{ "cod": 401, "message": "Invalid API key. Please see //openweathermap.org/faq#error401 for more info." }

Enamik API-sid nõuab enne andmete tagastamist mingisugust autentimist. See on tavaliselt API võtme kujul . Need võtmed on nagu parool. Need on pikad tähtede ja numbrite stringid, mille peate saatma koos API-taotlusega, et server teaks, et teil on lubatud teabele juurde pääseda.

OpenWeatheri API ja paljude teiste API-de jaoks saate API-võtme pärast konto loomist tasuta. Paljud ettevõtted kasutavad API-võtmeid tasuta API-de jaoks, et inimesed ei esitaks ühe päeva jooksul paljusid taotlusi. See võib tõesti ummistada serveri, kui üks inimene esitaks iga minut tuhandeid taotlusi.

Mõni API on ilma API võtmeta avalik. Allpool on API, mis võimaldab teil leida riimisõnu. Klõpsake lingil ja proovige URL-is muuta viimast sõna, et otsida erinevaid riimisõnu.

//api.datamuse.com/words?rel_rhy=camp

Kas soovite rohkem teada saada?

Kui soovite API-de kasutamise kohta lisateavet, vaadake YouTube'i kanalil freeCodeCamp.org allolevat videot.