REST API v1

API Reference

Спецификация REST API платформы Gupil для интеграции интернет-магазинов, касс и внешних CRM.

Базовые параметры и аутентификация

Base URL

https://gupil.ru/api

Content-Type

application/json

Для взаимодействия с Webhook используется параметр webhookSecret проекта в URL. Для вызовов административного API передаётся заголовок Authorization: Bearer <token> или авторизационная cookie.

Webhook API (Приём событий)

Основной шлюз для приёма транзакций, заказов и регистраций клиентов:

POST/api/webhook/{webhookSecret}

Пример тела запроса (начисление за покупку):

{
  "action": "purchase",
  "payload": {
    "email": "customer@example.com",
    "phone": "+79001234567",
    "amount": 4500,
    "orderId": "ORDER-9876",
    "description": "Покупка в интернет-магазине"
  }
}

Успешный ответ (200 OK):

{
  "success": true,
  "action": "purchase",
  "earnedBonuses": 225,
  "currentBalance": 725
}

Ограничение частоты запросов (Rate Limiting)

Для защиты от атак и исчерпания ресурсов на всех эндпоинтах действует Redis-based rate limiting. При превышении лимита возвращается HTTP-статус 429 Too Many Requests со временем сброса счётчика.