Сервис API склада
Сервис API на собственном сервере: данные в Postgres, маршруты ниже. Версия f7fe67f23d25efa09a2256cfbb6bfb0aa5c01146.
GET | /api/health | Состояние сервиса: версия и доступность базы |
GET | /api/info | Название сервиса и список маршрутов |
GET | /api/notes | Список заметок (пример ресурса) |
GET | /api/notes/:id | Одна заметка |
POST | /api/notes | Создать заметку: { title, body } ключ |
PATCH | /api/notes/:id | Изменить заметку ключ |
DELETE | /api/notes/:id | Удалить заметку ключ |
GET | /api/products | Список товаров; ?q= поиск по артикулу и названию, ?inStock=1 только в наличии |
GET | /api/products/:sku | Товар по артикулу |
POST | /api/products | Создать товар: { sku, name, qty, priceRub } ключ |
PATCH | /api/products/:sku | Изменить остаток и цену: { qty, priceRub } ключ |
DELETE | /api/products/:sku | Удалить товар ключ |
POST | /api/products/:sku/reserve | Зарезервировать со склада: { qty }; не хватает остатка - 409 ключ |
POST | /api/requests | ОТКРЫТ БЕЗ КЛЮЧА (форма с сайта): заявка { sku, qty, name, phone, comment, consent }; не больше 5 заявок с одного адреса за 10 минут |
GET | /api/requests | Последние 100 заявок; ?status=new только новые ключ |
PATCH | /api/requests/:id | Сменить статус заявки: { status: "new" | "done" } ключ |
Как подключиться
Чтение открыто. Запросы, которые меняют данные, требуют заголовок X-Api-Key; ключ задаётся в кабинете в разделе «Переменные окружения» как API_KEY.
curl https://api-demo.pmlx.ru/api/notes
curl -X POST https://api-demo.pmlx.ru/api/notes \
-H "Content-Type: application/json" -H "X-Api-Key: ВАШ_КЛЮЧ" \
-d '{"title":"Заголовок","body":"Текст"}'