Що означає API? Визначення абревіатури кодування простою англійською мовою.

Ні, API не означає Apple Pie Inside. ?? API розшифровується як Інтерфейс програмування програм. API дозволяють двом додаткам взаємодіяти (або взаємодіяти) між собою.

API - набір інструкцій та функцій програмування, що використовуються для доступу до веб-сайту або веб-програмного додатку. API дозволяє іншим розробникам використовувати дані та функціональність вашого додатка. Це дозволяє вашому товару взаємодіяти з іншими продуктами.

Вперше API були використані при розробці програмного та апаратного забезпечення у 1980-х. Але зараз, коли люди говорять про API, вони зазвичай мають на увазі веб-API, а точніше RESTful API. Поширеною практикою стало використання RESTful API при розробці веб-додатків.

Веб-API - це в основному програма, з якою ви взаємодієте повністю за допомогою URL-адрес. Зазвичай, коли ви надсилаєте запит на URL-адресу за допомогою браузера, сервер надсилає відповідь, що відображається для вас. Інакше йдуть справи, коли ви надсилаєте запит на URL-адресу API. Сервер надсилає назад те, що має бути корисним лише для комп'ютера. API повертає дані, які можна використовувати на іншому веб-сайті чи програмі.

Для чого використовуються API?

API не призначені для використання кінцевим користувачем. Вони використовуються для програмного забезпечення для взаємодії з іншим програмним забезпеченням. Наприклад, веб-сайт може зателефонувати до Open Weather 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 із параметром міста:

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, перегляньте відео нижче на YouTube-каналі freeCodeCamp.org.