Какво означава API? Определение на съкращението за кодиране на обикновен английски.

Не, API не означава Apple Pie Inside. ?? API означава интерфейс за програмиране на приложения. API позволяват на две приложения да взаимодействат (или да си взаимодействат) помежду си.

API набор от инструкции и функции за програмиране, използвани за достъп до уебсайт или уеб-базирано софтуерно приложение. API позволява на други разработчици да използват данните и функционалността на вашето приложение. Тя позволява на вашия продукт да взаимодейства с други продукти.

API за първи път се използват при разработването на софтуер и хардуер през 80-те години. Но сега, когато хората говорят за API, те обикновено се позовават на уеб API или по-точно RESTful API. Стана обичайна практика да се използват RESTful API при разработването на уеб-базирани приложения.

Уеб API е основно програма, с която взаимодействате изцяло чрез URL адреси. Обикновено, когато изпращате заявка до URL с вашия браузър, сървърът изпраща обратно отговор, който се показва, за да можете да го разгледате. Нещата са различни, когато изпратите заявка до URL адрес на API. Сървърът изпраща обратно нещо, което е предназначено да бъде полезно само за компютър. API връща данни, които могат да се използват в различен уебсайт или програма.

За какво се използват API?

API не са предназначени да се използват от краен потребител. Те се използват за софтуер за взаимодействие с друг софтуер. Например уебсайт може да се обади на API за отворено време, за да получи информация за времето, която да се показва на уебсайта.

API понякога се използват и вътрешно в рамките на една компания. Те могат да се използват за създаване на вътрешни уебсайтове и системи, които лесно си взаимодействат.

Как работи API?

API обикновено предоставя на другите достъп до голямо количество организирани данни. Вратарят на тези данни дава разрешение на разработчика (под формата на API ключ ) да поиска информация от сървър. Ако заявката е успешна, сървърът отговаря със съобщение, обикновено в JSON или XML формат.

Обикновено ще има документация за API, който искате да използвате, наречен API спецификация. Това обяснява контролите и как да използвате API.

Ето пример за спецификацията на API за API на OpenWeather, която ви позволява да получите текущото време на определено място: //openweathermap.org/current

Спецификациите на API съдържат списък с URL адреси, които можете да използвате за извличане на данни. Използването на един от URL адресите се нарича API заявка или API повикване . Често спецификацията ще показва параметри и отговора за всеки URL, който е част от API.

Параметри

Параметрите са това, което добавяте в края на URL, за да укажете каква информация искате да върне API. Параметрите са основно променливи, които предавате на API.

URL адресът за получаване на информация за времето от API на OpenWeather е:

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

Трябва обаче да добавите град като параметър, за да посочите за кое местоположение да връщате данни за времето. Ето URL адреса с параметъра city:

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

Понякога се изискват параметри, за да се получи отговор. Понякога параметрите не са задължителни. В API на OpenWeather се изисква да предоставите местоположение, но освен името на града има и други начини за определяне на местоположението. Всички начини са дадени в спецификацията на API.

Параметрите могат също да определят неща като:

  • Как трябва да се сортират резултатите?
  • Колко резултата трябва да бъдат върнати?
  • В какъв формат трябва да бъдат резултатите?
  • За какъв период от време искате резултати?

Отговорът

Когато изпратите заявка до API, ще получите отговор. Или ще получите обратно данните, които сте поискали, или причина, поради която заявката е неуспешна.

По-долу е пример за отговора ще получите, когато ви изпрати следната молба: api.openweathermap.org/data/2.5/weather?q=London. Това е JSON отговор.

{ "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 отговор не може да бъде форматиран като този пример. Целият текст често е на един ред. Тъй като е предназначен главно да се чете от компютър, а не от човек, форматирането няма значение.

API ключове

Ако опитате сами горния URL адрес, няма да получите отговора по-горе. Вероятно ще изглежда по-скоро като:

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

Повечето API изискват някакъв вид удостоверяване, преди да върнат данни. Това обикновено е под формата на API ключ . Тези ключове са нещо като парола. Те представляват дълъг низ от букви и цифри, които трябва да изпратите с вашата заявка за API, така че сървърът да знае, че имате право на достъп до информацията.

За API на OpenWeather и за много други API можете да получите API ключ безплатно след създаване на акаунт. Много компании използват API ключове на безплатни API, за да се уверят, че хората не отправят много заявки за един ден. Наистина би могло да затъне сървър, ако един човек отправя хиляди заявки всяка минута.

Някои API са публични без API ключ. По-долу е API, който ви позволява да намерите римувани думи. Щракнете върху връзката, след което опитайте да промените последната дума в URL адреса, за да търсите различни римувани думи.

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

Искате ли да научите повече?

Ако искате да научите повече за използването на API, вижте видеоклипа по-долу в канала на freeCodeCamp.org YouTube.