Приложения

Раздел API для управления приложениями в системе ERP. Поддерживает получение списка приложений, управление вебхуками, категориями, брендами и пунктами меню приложения.

Приложения

Получение списка приложений

Метод: GET
URL: https://api.gigma.ru/api/applications
Авторизация: Bearer token
Headers: Authorization: Bearer {token}

Параметры запроса

page — текущая страница
per_page — количество элементов на странице
query — поисковая строка
date_from — фильтр по дате (от)
date_to — фильтр по дате (до)

Ответ

При успешном действии возвращается HTTP код 200.

Получение выбранного приложения

Метод: GET
URL: https://api.gigma.ru/api/applications/{id}
Авторизация: Bearer token
Headers: Authorization: Bearer {token}

Ответ

При успешном действии возвращается HTTP код 200.

{
    "application": {
        "id": 1,
        "branch": { "id": 5, "name": "Главный филиал" },
        "is_website": false,
        "photo": null,
        "code": "APP-001",
        "name": "Интернет-магазин",
        "is_token_active": true,
        "wholesale": false,
        "token": "abc123token",
        "success_payment_url": "https://myshop.ru/success",
        "warehouses": [{ "id": 3, "name": "Склад №1" }],
        "sales_strategy": { "id": 1, "name": "Стандартная" }
    }
}

Описание полей

branch — объект филиала (id, name)
is_website (bool) — является ли приложение сайтом
photo — объект файла-обложки (или null)
code — уникальный код приложения
name — название приложения
is_token_active (bool) — активен ли API-токен приложения
wholesale (bool) — работает ли приложение в оптовом режиме
token (string|null) — API-токен приложения для E-Commerce запросов
success_payment_url (string|null) — URL редиректа после успешной оплаты
warehouses — массив складов, привязанных к приложению
sales_strategy (object|null) — стратегия продаж (id, name)

Вебхуки приложения

Получение списка вебхуков

Метод: GET
URL: https://api.gigma.ru/api/applications/{id}/webhooks
Авторизация: Bearer token
Headers: Authorization: Bearer {token}

Ответ

При успешном действии возвращается HTTP код 200 с массивом вебхуков приложения.

Создание вебхука

Метод: POST
URL: https://api.gigma.ru/api/applications/{id}/webhooks
Авторизация: Bearer token
Headers: Authorization: Bearer {token}

Параметры запроса

url (string, обязательно) — URL для отправки вебхуков
events (string[], опционально) — массив подписанных событий

Ответ

При успешном действии возвращается HTTP код 201 с созданным вебхуком.

Получение выбранного вебхука

Метод: GET
URL: https://api.gigma.ru/api/applications/{id}/webhooks/{webhook_id}
Авторизация: Bearer token
Headers: Authorization: Bearer {token}

Ответ

При успешном действии возвращается HTTP код 200 с объектом вебхука.

Обновление вебхука

Метод: PATCH
URL: https://api.gigma.ru/api/applications/{id}/webhooks/{webhook_id}
Авторизация: Bearer token
Headers: Authorization: Bearer {token}

Параметры запроса

Те же параметры, что и при создании (частичное обновление).

Ответ

При успешном действии возвращается HTTP код 200 с обновлённым вебхуком.

Удаление вебхука

Метод: DELETE
URL: https://api.gigma.ru/api/applications/{id}/webhooks/{webhook_id}
Авторизация: Bearer token
Headers: Authorization: Bearer {token}

Ответ

При успешном действии возвращается HTTP код 200.

Получение доставок вебхука

Метод: GET
URL: https://api.gigma.ru/api/applications/{id}/webhooks/{webhook_id}/deliveries
Авторизация: Bearer token
Headers: Authorization: Bearer {token}

Ответ

При успешном действии возвращается HTTP код 200 с историей доставок вебхука.

Повторная доставка вебхука

Метод: POST
URL: https://api.gigma.ru/api/applications/{id}/webhooks/{webhook_id}/resend
Авторизация: Bearer token
Headers: Authorization: Bearer {token}

Ответ

При успешном действии возвращается HTTP код 200.

Ротация секрета вебхука

Метод: POST
URL: https://api.gigma.ru/api/applications/{id}/webhooks/{webhook_id}/rotate-secret
Авторизация: Bearer token
Headers: Authorization: Bearer {token}

Генерирует новый секрет для подписи полезной нагрузки вебхука.

Ответ

При успешном действии возвращается HTTP код 200 с новым секретом.

Категории приложения

Получение списка категорий приложения (табличное)

Метод: GET
URL: https://api.gigma.ru/api/tables/applications/{id}/categories
Авторизация: Bearer token
Headers: Authorization: Bearer {token}

Ответ

При успешном действии возвращается HTTP код 200.

Добавление категории в приложение

Метод: POST
URL: https://api.gigma.ru/api/applications/{id}/categories
Авторизация: Bearer token
Headers: Authorization: Bearer {token}

Параметры запроса

category_id — ID категории

Ответ

При успешном действии возвращается HTTP код 200.

Получение категории приложения

Метод: GET
URL: https://api.gigma.ru/api/applications/{id}/categories/{category_id}
Авторизация: Bearer token
Headers: Authorization: Bearer {token}

Ответ

При успешном действии возвращается HTTP код 200.

Удаление категории из приложения

Метод: DELETE
URL: https://api.gigma.ru/api/applications/{id}/categories/{category_id}
Авторизация: Bearer token
Headers: Authorization: Bearer {token}

Ответ

При успешном действии возвращается HTTP код 200 с сообщением подтверждения.

Повышение приоритета категории

Метод: POST
URL: https://api.gigma.ru/api/applications/{id}/categories/{category_id}/up
Авторизация: Bearer token
Headers: Authorization: Bearer {token}

Ответ

При успешном действии возвращается HTTP код 200.

Понижение приоритета категории

Метод: POST
URL: https://api.gigma.ru/api/applications/{id}/categories/{category_id}/down
Авторизация: Bearer token
Headers: Authorization: Bearer {token}