Що таке кінцева точка API?

Кінцева точка API — це цифрове місце, де API отримує запити щодо певного ресурсу на своєму сервері. В API кінцева точка зазвичай є уніфікованим покажчиком ресурсу (URL), який визначає розташування ресурсу на сервері.

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

Щоб інтегрувати два програмні застосунки через Інтернет, один застосунок, який називають клієнтом, надсилає запит до API іншого застосунку. Клієнт може запросити ресурс із бази даних застосунку або попросити виконати дію на сервері.

Отримавши й перевіривши запит клієнта, API виконує запитану дію, а потім надсилає відповідь клієнту. Ця відповідь містить статус запиту (наприклад, завершено або відхилено) та будь-які ресурси, запитані клієнтом.

Зазвичай API дають змогу отримати доступ до багатьох різних ресурсів на сервері. Наприклад, API соціальної мережі може давати клієнтам змогу отримувати й змінювати вміст дописів, профілі користувачів і зображення. API новинного сайту надасть доступ до вмісту його статей, авторів і медіаматеріалів, таких як подкасти та відео.

Знаючи це, як клієнти вказують, до якого ресурсу вони хочуть отримати доступ у своєму запиті?

Відповідь полягає у використанні правильної кінцевої точки. У своїх запитах клієнти вказують кінцеву точку у вигляді URL-адреси. Ця URL-адреса повідомляє серверу: «Потрібний мені ресурс міститься тут».

Цей процес подібний до доступу до вебсторінок у браузері. Веббраузери завантажують вебсторінки, надсилаючи URL-адресу вебсерверу, а сервер відповідає запитаною сторінкою. Так само клієнту потрібна правильна URL-адреса кінцевої точки, щоб запросити певний ресурс з API.

Кінцева точка й API

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

Приклади кінцевих точок API

Розробники перелічують усі кінцеві точки свого API в документації, щоб користувачі знали, як отримати доступ до потрібних їм ресурсів. Але який вигляд ці кінцеві точки мають на практиці? Розгляньмо кілька реальних прикладів від провідних платформ.

Приклад кінцевої точки API Twitter

API Twitter надає дані про твіти, прямі повідомлення, користувачів та багато іншого.

Припустімо, ви хочете отримати вміст певного твіту. Для цього можна скористатися кінцевою точкою пошуку твітів, URL-адреса якої — https:// api.twitter.com/2/tweets/{id} (де {id} — унікальний ідентифікатор твіту).

А тепер припустімо, що ви хочете, аби ваш вебсайт транслював загальнодоступні твіти в режимі реального часу, щоб відвідувачі були в курсі певної теми. Ви можете скористатися кінцевою точкою відфільтрованого потоку Twitter, URL-адреса якої — https:// api.twitter.com/2/tweets/search/stream.

Приклад кінцевої точки API Spotify

API Spotify надає розробникам доступ до пісень, виконавців, плейлистів і даних користувачів. Наприклад, якщо ви хочете отримати певний альбом, можна отримати доступ до будь-якого альбому в каталозі Spotify за допомогою кінцевої точки https:// api.spotify.com/v1/albums/{id} (де {id} — унікальний номер альбому). ідентифікатор).

Або, скажімо, ви хочете надіслати запит, який змусить користувача стежити за плейлистом. У цьому випадку надішліть запит PUT із кінцевою точкою https:// api.spotify.com/v1/playlists/{playlist_id}/followers (де {playlist_id} — унікальний ідентифікатор плейлиста).

Приклад кінцевої точки API YouTube

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

Інший спосіб отримати відео через API YouTube — запитати їх у кінцевої точки https:// www.googleapis.com/youtube/v3/videos, яка повертає список відео, що відповідають параметрам, указаним у запиті.

Чому кінцеві точки API важливі?

Одне з перших запитань, які ви ставите про API, звучить так: чому так багато компаній відкрито й безкоштовно діляться своїми даними?

Найчастіше відповідь — масштаб. У міру зростання компаній їхні працівники розуміють, що в них більше ідей, ніж часу та ресурсів для їхнього втілення. Зазвичай простіше співпрацювати з іншими зовнішніми компаніями, які спеціалізуються на цих ідеях, ніж розробляти їх самостійно.

Створюючи API, компанія дає стороннім розробникам змогу створювати застосунки, які покращують впровадження та використання її платформи. Таким чином бізнес може побудувати екосистему, яка починає залежати від даних із його API, що часто відкриває додаткові можливості для отримання доходу.

Візьмімо API HubSpot як ще один приклад: відкриваючи функціональність і дані нашого програмного забезпечення через API, розробники можуть інтегрувати свої застосунки з нашою технологією, створюючи екосистему застосунків, яка розширює наше охоплення та значно спрощує роботу клієнтам, які хочуть використовувати інші застосунки разом із HubSpot. .

Як ми з’ясували, кінцеві точки буквально посідають центральне місце в API. Саме в цій точці спілкуються клієнт і сервер. Без належно структурованих і функціональних кінцевих точок API буде в найкращому разі заплутаним, а в найгіршому — зламаним. Надаючи більше даних через свій API, надзвичайно важливо переконатися, що кожна кінцева точка надає клієнтам цінні ресурси.

Як тестувати кінцеві точки API

Обговорюючи веб-API, ми зазвичай говоримо про тип API, який називається REST API і використовує методи HTTP, що повідомляють API, яку дію потрібно виконати. Чотири найпоширеніші методи HTTP у запитах API:

GET: отримує ресурс
POST: створює ресурс
PUT: оновлює наявний ресурс
DEL: видаляє ресурс

Розгляньмо, як зробити запит до кінцевої точки відфільтрованого потоку API Twitter. Запити форматують, записуючи метод HTTP, за яким іде URL-адреса кінцевої точки. Отже, запит до кінцевої точки відфільтрованого потоку матиме такий вигляд: POST https:// api.twitter.com/2/tweets/search/stream.

Ми можемо застосувати до кінцевої точки критерії фільтрації у вигляді правил. Щоб побудувати ці правила, ви використовуватимете набір операторів. У цьому прикладі можна використати два оператори Twitter API — from: і has:links — щоб переглядати твіти лише від певних облікових записів, які містять посилання.

У своєму запиті ви використовуватимете метод HTTP POST. Окрім згаданого вище правила, у запиті потрібно вказати тип вмісту й авторизацію. Нижче тип вмісту визначено як «application/json», тому запит відображається у форматі даних jаvascript Object Notation (JSON).

Існує кілька онлайн-інструментів для тестування кінцевої точки API. Тут ми скористаємося c URL — інструментом командного рядка, що підтримує HTTP. Він може надсилати запити, отримувати й надсилати дані, тож це чудовий інструмент для тестування API.

Майбутнє API у бізнесі

Ми живемо у світі, який тепер вимагає відкритого й доступного для всіх вмісту — природним розвитком цього процесу є те, що самі видавці випускають власні API, щоб клієнти могли розробляти застосунки разом із ними.

Спільне використання API стосується всіх підприємств: не лише тих, що працюють в Інтернеті, а й усіх, у кого є вебінструмент або компонент в організації. Звісно, ця концепція створить перешкоди для деяких організацій; головна з них — забезпечити, щоб усі розуміли, як працюють API.

Легко загрузнути в технічному жаргоні API. Однак на реальних прикладах легше зрозуміти, як працюють API. Сподіваюся, тепер ви краще розібралися з одним із їхніх ключових компонентів — кінцевими точками.