Hvad står API for? En definition af kodningsakronymet på almindeligt engelsk.

Nej, API står ikke for Apple Pie Inside. ?? API står for Application Programming Interface. API'er tillader to applikationer at interface (eller interagere) med hinanden.

En API et sæt programmeringsinstruktioner og funktioner, der bruges til at få adgang til et websted eller en webbaseret softwareapplikation. En API giver andre udviklere mulighed for at bruge din applikations data og funktionalitet. Det giver dit produkt mulighed for at interagere med andre produkter.

API'er blev først brugt til software- og hardwareudvikling i 1980'erne. Men nu når folk taler om API'er, henviser de normalt til web-API'er eller mere specifikt RESTful API'er. Det er blevet almindelig praksis at bruge RESTful API'er, når de udvikler webbaserede applikationer.

En web-API er dybest set et program, som du interagerer med fuldstændigt gennem URL'er. Normalt når du sender en anmodning til en URL med din browser, sender en server et svar tilbage, der vises, så du kan se på det. Ting er forskellige, når du sender en anmodning til en URL til en API. Serveren sender noget tilbage, der kun er beregnet til at være nyttigt til computeren. En API returnerer data, der kan bruges på et andet websted eller program.

Hvad bruges API'er til?

API'er er ikke beregnet til at blive brugt af en slutbruger. De bruges til software til at interagere med anden software. For eksempel kan et websted ringe til Open Weather API for at få vejrinformation til at blive vist på webstedet.

API'er bruges også undertiden internt inden for en enkelt virksomhed. De kan bruges til at oprette interne websteder og systemer, der let interagerer med hinanden.

Hvordan fungerer en API?

En API giver generelt andre adgang til en stor mængde organiserede data. Gatekeeperen af ​​disse data giver en udvikler tilladelse (i form af en API-nøgle ) til at bede en server om information. Hvis anmodningen er vellykket, svarer serveren med en besked, normalt i JSON- eller XML-format.

Normalt vil der være dokumentation for en API, du vil bruge, kaldet en API-specifikation. Dette forklarer kontrollerne, og hvordan man bruger API'en.

Her er et eksempel på API-specifikationen til OpenWeather API, der giver dig mulighed for at få det aktuelle vejr på et bestemt sted: //openweathermap.org/current

API-specifikationer indeholder en liste over webadresser, du kan bruge til at hente data. Brug af en af ​​URL'erne kaldes en API-anmodning eller API-opkald . Ofte viser specifikationen parametre og svaret for hver URL, der er en del af API'et.

Parametre

Parametre er det, du tilføjer i slutningen af ​​en URL for at specificere, hvilke oplysninger du vil have API'en til at returnere. Parametre er grundlæggende variabler, du sender til API'en.

URL'en til at få vejrinformation fra OpenWeather API er:

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

Du skal dog tilføje en by som parameter for at angive, hvilken placering du vil returnere vejrdata til. Her er URL'en med byparameteren:

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

Nogle gange kræves parametre for at få et svar. Nogle gange er parametre valgfri. I OpenWeather API er det nødvendigt at angive en placering, men der er andre måder at specificere placeringen ud over bynavnet. Alle måder er angivet i API-specifikationen.

Parametre kan også specificere ting som:

  • Hvordan skal resultaterne sorteres?
  • Hvor mange resultater skal returneres?
  • Hvilket format skal resultaterne være?
  • Hvilket datointerval ønsker du resultater for?

Svaret

Når du sender en anmodning til en API, får du et svar tilbage. Du får enten de ønskede data tilbage eller en grund til, at anmodningen mislykkedes.

Nedenfor er et eksempel på et svar, du får, når du sende følgende anmodning: api.openweathermap.org/data/2.5/weather?q=London. Det er et JSON-svar.

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

Et API-svar formateres muligvis ikke som dette eksempel. Hele teksten er ofte på en enkelt linje. Da det primært er meningen, at det skal læses af en computer og ikke en person, betyder formateringen ikke noget.

API-nøgler

Hvis du selv prøver ovenstående URL, får du ikke svaret ovenfor. Det vil sandsynligvis se mere ud som:

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

De fleste API'er kræver en slags godkendelse, før de returnerer data. Dette er normalt i form af en API-nøgle . Disse nøgler er som en adgangskode. De er en lang række bogstaver og tal, som du skal sende med din API-anmodning, så serveren ved, at du har adgang til oplysningerne.

Til OpenWeather API og med mange andre API'er kan du få en API-nøgle gratis efter oprettelse af en konto. Mange virksomheder bruger API-nøgler på gratis API'er for at sikre, at folk ikke fremsætter mange anmodninger på en dag. Det kunne virkelig knuse en server, hvis en enkelt person fremsatte tusindvis af anmodninger hvert minut.

Nogle API'er er offentlige uden en API-nøgle. Nedenfor er en API, der giver dig mulighed for at finde rimord. Klik på linket, og prøv derefter at ændre det sidste ord i URL'en for at søge efter forskellige rimord.

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

Vil du lære mere?

Hvis du vil lære mere om brug af API'er, skal du tjekke videoen nedenfor på freeCodeCamp.org YouTube-kanalen.