Разработка 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 на вашем сайте.