Що означає API?

Скорочення API від Application Programming Interface означає набір функціональних кодів, які дозволяють програмам отримувати доступ до вказаних даних і взаємодіяти із зовнішніми компонентами програмного забезпечення, операційними системами або мікросервісами.

Щоб спростити, API доставляє відповідь користувача системі та надсилає відповідь системи назад користувачеві. Ви натискаєте «додати в кошик»; API повідомляє сайту, що ви додали продукт у свій кошик; веб-сайт поміщає продукт у ваш кошик, і ваш кошик оновлюється.

Ви можете почути термін «мікросервіси» стосовно API. Однак це не те саме. Мікросервіси – це стиль або архітектура, яка розділяє функціональність у веб-додатку. Хоча API — це структура, за допомогою якої розробники взаємодіють із веб-програмою. Мікросервіси насправді можуть використовувати API для спілкування між собою.

API дозволяє розробнику зробити певний «дзвінок» або «запит», щоб надіслати або отримати інформацію. Цей зв’язок здійснюється за допомогою мови програмування під назвою «JSON». Його також можна використовувати для виконання визначеної дії, наприклад оновлення або видалення даних. Є чотири основні методи запиту, які можна зробити за допомогою API:

GET – збирає інформацію (витягує всі коди купонів)

PUT – Оновлення фрагментів даних (Оновлення цін на продукт)

POST – створює (створення нової категорії продукту)

DELETE – (Видалення публікації в блозі)

Що таке JSON і для чого він використовується?

JSON (JavaScript Object Notation) використовується для представлення даних на сервері. Його досить легко прочитати людям і легко зрозуміти машинам/додаткам. Давайте розглянемо приклад JSON із продукту на BigCommerce:

Це легко зрозуміти, оскільки він виводиться в парах ключ/значення, з ключем ліворуч і значенням праворуч. Ключі є фіксованим об’єктом, визначеним програмою, і залишатимуться такими ж, як і «категорія». Тоді як значення будуть унікальними, наприклад «Сорочки».

Що таке запит API?

Існує кілька компонентів API-запиту для його функціонування. Давайте розглянемо їх окремо та розглянемо, як їх можна використовувати для створення запиту.

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

Є дві ключові частини кінцевої точки, які використовуються під час надсилання запиту API. Одним із них є URL-адреса. BigCommerce використовує https://api.bigcommerce.com/stores/ як URL-адресу для всіх запитів API. Це може виглядати як звичайна URL-адреса, але якщо ви підключите її до веб-переглядача, ви отримаєте повідомлення про помилку 404.

Друга частина – шлях. Шлях буде різним залежно від того, чого ви намагаєтеся досягти. Ви можете знайти список доступних шляхів для BigCommerce, відвідавши нашу документацію для розробників: https://developer.bigcommerce.com/api-reference. У цьому прикладі ми будемо використовувати шлях до продукту, тобто /v3/catalog/products.

Коли ми об’єднуємо ці дві частини, ми отримуємо повну кінцеву точку https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products. Тепер ви можете запитати себе: «Що таке {store_hash}?» «Звідки це взялося?» Це те, що відомо як змінна. Змінні — це унікальні компоненти кінцевої точки, які залежать від інформації вашого магазину. Ви можете визначити змінну за відкритими та закритими дужками “{ }”.

Що таке заголовок?

Заголовки надають інформацію клієнту та серверу. Типовими прикладами заголовка можуть бути облікові дані автентифікації, такі як «Auth Token» або «Client ID». Ці облікові дані надаються вам автоматично під час створення облікового запису API. Інший поширений заголовок називається «Тип вмісту», який інформує сервер про те, який тип вмісту буде надіслано. Наприклад, часто використовуваним типом вмісту є «application/json», який повідомляє серверу, що ми надсилаємо дані JSON.

Що таке метод?

Методи — це дії, які виконуються під час надсилання запиту. Поверніться до початку, коли ми обговорювали GET, PUT, POST і DELETE. Це всі методи API.

Що таке дані?

Дані запиту, які також зазвичай називають «тілом», — це інформація, яка надсилається або повертається сервером. У попередньому обговоренні JSON ви можете побачити приклад даних API. У тілі запиту іноді потрібна певна інформація, перш ніж його можна буде доставити. Прикладом цього є те, що якщо ви редагуєте один продукт, перед внесенням будь-яких змін потрібно буде вказати ідентифікатор продукту.

Читати далі тут.