Что означает API?

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

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

Вы можете услышать термин «микросервисы» применительно к API. Однако это не одно и то же. Микросервисы — это стиль или архитектура, которая разделяет функциональность внутри веб-приложения. А API — это платформа, с помощью которой разработчики взаимодействуют с веб-приложением. Микросервисы на самом деле могут использовать API для связи между друг другом.

API позволяет разработчику сделать определенный «вызов» или «запрос» для отправки или получения информации. Эта связь осуществляется с использованием языка программирования под названием «JSON». Его также можно использовать для выполнения определенного действия, например обновления или удаления данных. Существует четыре основных метода запроса, которые можно выполнить с помощью API:

GET – собирает информацию (извлекает все коды купонов)

PUT — обновляет фрагменты данных (обновление цен на продукты).

POST – Creates (создание новой категории продуктов)

DELETE – (Удаление сообщения в блоге)

Что такое JSON и почему он используется?

JSON (нотация объектов JavaScript) используется для представления данных на сервере. Его довольно легко читать людям и легко понять машинам/приложениям. Давайте посмотрим на пример 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}?», «Откуда он взялся?» Это то, что известно как переменная. Переменные являются уникальными компонентами конечной точки и могут различаться в зависимости от информации вашего магазина. Вы можете определить переменную по открытым и закрытым скобкам «{ }».

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

Заголовки предоставляют информацию клиенту и серверу. Типичными примерами заголовка могут быть учетные данные аутентификации, такие как «Токен аутентификации» или «Идентификатор клиента». Эти учетные данные предоставляются вам автоматически при создании учетной записи API. Другой распространенный заголовок называется «Тип контента», который информирует сервер о том, какой тип контента будет отправлен. Например, часто используемый тип контента — «application/json», который сообщает серверу, что мы отправляем данные JSON.

Что такое Метод?

Методы — это действия, предпринимаемые при отправке запроса. Вспомните начало, когда мы обсуждали GET, PUT, POST и DELETE. Это все методы API.

Что такое данные?

Данные запроса, также часто называемые «телом», представляют собой информацию, которая будет отправлена ​​или возвращена сервером. В предыдущем обсуждении JSON вы могли увидеть пример данных API. Тело запроса иногда требует конкретной информации, прежде чем его можно будет доставить. Например, если вы редактируете один продукт, перед внесением каких-либо изменений потребуется идентификатор продукта.

Читать далее здесь.