API-сұрату – бұл сатушыдан немесе техникалық маманнан Kaspi.kz дүкен алатын нұсқаулық.
Онда деректерді кім алғысы келетіні және жауапта қандай ақпаратты ұсыну керектігі сипатталған. Kaspi.kz-тегі Магазинде API-сұратуда мыналар қамтылуы керек:
1. Әдіс.
Іс-әрекеттің сипаттамасы:
- GET — деректерді сұрайды.
- PUT — деректерді жаңартады немесе жаңаларын қосады.
- POST — ақпаратты жүктейді.
2. Параметрлер.
Жауап қалыптастырылатын шарттар.
Kaspi.kz-тегі Магазинде әр сұратуда әртүрлі параметрлер жиынтығы пайдаланылады. Мысалы:
sort — нәтижені сұрыптау;
page — жауапта қандай бет беріледі немесе онда қанша мән болады;
filter — нысан бойынша іріктеу.
3. Тақырып.
Нұсқаулықты дұрыс өңдеу үшін қосымша ақпарат:
- Content-Type — деректерді жіберу пішімі. Kaspi.kz-тегі Магазинде бұл JSON.
- X-Auth-Token — авторизация токені.
- Accept — жауаптағы қажетті контент түрі.
Сондай-ақ API-сұратуда атрибуттар пайдаланылуы мүмкін — бұл жауаптағы деректердің сипаттамасы.
