API-запрос — это инструкция, которую получает Магазин на Kaspi.kz от продавца или технического специалиста.
В ней описано, кто хочет получить данные и какую информацию необходимо предоставить в ответе.
API-запрос в Магазине на Kaspi.kz должен содержать:
1. Метод.
Описание действия:
- GET — запрашивает данные.
- PUT — обновляет данные или добавляет новые.
- POST — загружает информацию.
2. Параметры.
Условия, по которым будет сформирован ответ. В Магазине на Kaspi.kz в каждом запросе используется разный набор параметров. Например:
sort — сортировка результата;
page — какая страница передается в ответе или сколько значений будет на ней;
filter — фильтр по объекту.
3. Заголовок.
Дополнительная информация для правильной обработки инструкции:
- Content-Type — формат передачи данных. В Магазине на Kaspi.kz это JSON.
- X-Auth-Token — токен авторизации.
- Accept — тип контента, который нужен в ответе.
Также в API-запросе могут использоваться атрибуты — это описание данных, которые будут в ответе.
