Розробка REST API

Що таке API

Абривіатура API (Application Programming Interface) - перекладається, як програмний інтерфейс додатку. API представляє набір правил і функцій, що дозволяють організовувати взаємодію між двома і більше програмними інтерфейсами. Часто ці інтерфейси кардинально відрізняються (написані на різних мовах, працюють на різних платформах та операційних системах). Таким чином API виступає в якості універсально інтерфейсу, який допомагає налагодити взаємодію там де це здавалось неможливим.

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

Що таке REST API

REST або Representational state transfer, що перекладається як передача стану додатку - це архітектурний стиль проектування API з використанням протоколу HTTP.

RESR API дозволяє організувати взаємодію між серверною частиною сайту (Backend) та клієнтською (Frontend) або зовнішніми клієнтськими додатками за допомогою протоколу HTTP.

Насправді універсальність та поширеність HTTP дозволяє будувати також ефективні серверні архітектури, які на пряму з клієнтами не взаємодіють.

API First

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

Суть парадигми API First полягає в тому, що Frontend сайту отримує дані через RESR API, навіть коли це один фреймворк, такий підхід дозволяє в будь-який момент використати ці дані в сторонньому інтерфейсі, наприклад мобільному додатку.

Розмежування прав доступу до API

Оскільки REST API дозволяє отримувати доступ до даних та маніпулювати ними, то постає питання безпеки. Розмежування прав доступу може бути легко організоване на стороні сервера, що дозволяє без проблем використовувати REST API в проектах, які вимагають використання політик безпеки із розмежуванням прав. Загалом прийнято умовно розділяти API на Open API (відкритий) та  Close API (закритий).

Open API

Він же відкритий API - не передбачає розмежування прав доступу до ресурсів і по своїй суті Open API підтримує одну політику безпеки - дозволено все.

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

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

Close API

Закритий API дозволяє налаштовувати політики безпеки залежно від потреб проекту. При користуванні Close API клієнт проходить аутентифікацію при кожному зверненні до API, зазвичай для цього використовується Токен персонального доступу (Personal access token), який видається клієнту автоматично, або в ручному режимі. Токен для сервера виступає ідентифікатором, який дозволяє зв'язати клієнта із користувачем в системі та надати йому відповідні повноваження.

Personal access token можуть видавати також сторонні сервіси, які використовують протокол OAuth для автоизації сторонніх додатків. OAuth підтримують Google, Facebook, GitHub та інші сервіси. Його можна також без проблем налаштувати на влсному сервері REST API.

Приклад використання REST API

Наприклад у нас є сайт який надає певні послуги, з його допомогою ми приймаємо та опрацьовуємо замовлення, поруч із цим ми використовуємо сторонню CRM (для зручності) розглянемо кілька рівнів взаємодії з API:

1. Оформлення замовлення - форма на сайті збирає дані про замовлення та клієнта і записує їх в базу даних через відкритий API сайту (сервер).
2. Вибір адреси доставки - при заповненні форми клієнт обирає зручне відділення для доставки, під час цього процесу клієнтська частина сайту через відкритий API служби доставки отримує перелік доступних для доставки відділень.
3. Передача даних в CRM - через закритий API CRM заявка потрапляє в CRM і стає доступною для менеджера
4. Опрацювання заявки - при зміні статусу заявки в CRM зміни фіксуються на нашому сайті, взаємодія відбувається через закритий API або веб-хук.
5. Відстеження статусу замовлення - через закритий API нашого сайту (сервера) клієнт отриує доступ до власного кабінету користувача на сайті, або в мобільному додатку.

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

Разово розроблений та налаштований API економить безліч часу працівників, автоматизує та оптимізує технічні процеси компанії. Також оптимальним варіантом буде використання REST API на вашому сайті.