Термины и общие положения

API — это интерфейс, который позволяет программам обмениваться данными между соб[1] ой.

В Halyk Market с помощью API продавцы и партнёры платформы могут получать и передавать данные о заказах, товарах, клиентах и доставке. Это делает процесс работы с системой автоматизированным и удобным — не нужно вручную заходить на сайт, так как все операции выполняются через запросы к системе. Через API можно: • получать список заказов и их статусы; • узнавать информацию о клиентах и точках продаж; • отслеживать доставку и курьерскую службу; • создавать или обновлять данные о товарах; • получать финансовую информацию (например, суммы заказов). Подобный принцип работы используется и во многих других платформах. Например, API активно применяют CRM-системы (Bitrix24, AmoCRM, HubSpot, Salesforce, Zoho CRM), бухгалтерские и учётные программы (1С:Предприятие, SAP, Oracle NetSuite, Microsoft Dynamics 365) и многие другие бизнес-сервисы. Благодаря API такие системы могут взаимодействовать между собой, синхронизировать данные и автоматизировать рабочие процессы. Postman — это программа для работы и тестирования API, которая позволяет отправлять запросы и анализировать ответы сервера. В рамках данной инструкции Postman используется не как инструмент тестирования, а как наглядный способ продемонстрировать структуру и принцип работы API-запросов (какие параметры передаются, каким образом формируется запрос и какой ответ возвращается). Каждый запрос к API содержит заголовки (headers) — это техническая часть, которая помогает серверу понять, кто делает запрос и что именно передаётся внутри. Два самых важных типа запросов, которые вы будете использовать чаще всего: Запросы API:

Тип запроса	Что это значит	Пример
POST-запрос	Отправка данных на сервер.	Отправить информацию о новом заказе, чтобы он создался в системе.
GET-запрос	Получение данных с сервера.	Получить список заказов или информацию о клиенте.
PUT-запрос	Обновление существующих данных на сервере (по ID).	Обновить статус заказа, адрес доставки или данные клиента.

Термины и элементы:

Понятие	Что это значит	Пример
Токен	Уникальный «пропуск» для доступа к системе. Используется для авторизации запросов.	Без токена сервер не примет запрос. Когда он истекает — нужно запросить новый.
Атрибуты запроса	Данные, которые передаются вместе с запросом.	orderNumber: "00012345", status: "DELIVERY"
Ответ сервера	То, что сервер возвращает после выполнения запроса.	Сообщение «Заказ успешно создан» или данные о заказе.
Атрибуты ответа	Информация внутри ответа сервера.	status: "ACCEPTED", totalPrice: 12500, deliveryMode: "PHYSICAL_SHIP"