Базові поняття
Щоб не було “воно не працює, бо я так відчував”:
Endpoint
Endpoint — це URL, куди ви відправляєте всі запити.
У вашому розгортанні (без папки public) найчастіше це просто:
POST https://<ваш-домен>/
У прикладах нижче ми будемо писати
https://api13.arm20.com/як базову адресу.
Method
Поле method у тілі JSON визначає, що саме ви хочете зробити.
Приклади:
service.pingget.products.listset.users.updateget.reports.sales
Params
params — це параметри конкретного методу (фільтри, дані для створення, ID запису тощо).
Meta
meta — технічні дані:
meta.user_card— обов'язково майже для всіх методів (окрімservice.ping)meta.client_name,meta.client_version— бажано, для журналів
Auth
Авторизаційні дані (login/password) можна передавати:
- стандартно через Basic Auth (заголовок
Authorization) - або всередині JSON через об'єкт
auth
І так, ще раз: логін/пароль = як в онлайн статистиці.