📚 API Reference

Полная документация по REST API InstantBase. Все эндпоинты, параметры и примеры.

🌐 Базовый URL

https://api.instantbase.online/v1

Все запросы должны использовать HTTPS

🔑 Аутентификация

Все запросы к API требуют API-ключ. Ключ передается в заголовке X-API-Key.

curl -X POST https://api.instantbase.online/v1/track \
  -H "X-API-Key: ваш_ключ" \
  -H "Content-Type: application/json" \
  -d '{"event":"test"}'

Подробнее об аутентификации →

📋 Все эндпоинты

📨

События

Отправка событий, получение ленты, топ событий, поиск

POST /track GET /events/live
👥

Клиенты

Профили клиентов, атрибуты, география, история изменений

GET /customers GET /geography
💰

Выручка

Выручка, заказы, средний чек, популярные товары

GET /revenue GET /orders/popular
📈

Удержание

Когортный анализ, retention Day 1/7/30, LTV

GET /retention
🔔

Вебхуки

Уведомления о событиях, настройка эндпоинтов

POST /webhooks GET /webhooks
🏷️

Метаданные

Настройка бизнес-логики: заказы, воронки, атрибуты

_metadata

⚡ Быстрый пример

// Отправка события о покупке
curl -X POST https://api.instantbase.online/v1/track \
  -H "X-API-Key: prod_key" \
  -H "Content-Type: application/json" \
  -d '{
    "event": "purchase",
    "user_id": "user_123",
    "properties": {
      "order_id": "ORD-001",
      "revenue": 1499.99,
      "items": [
        {"id": "prod_1", "name": "Футболка", "price": 1999, "quantity": 2}
      ]
    },
    "_metadata": {
      "is_order": true,
      "funnel_sales_step": 4
    }
  }'

📦 SDK и библиотеки

Используйте готовые SDK для популярных языков

JavaScript Python PHP iOS / Android

📊 Коды ответов HTTP

Код Описание Действие
200 OK Успешный запрос Событие принято
400 Bad Request Неверный JSON или отсутствуют обязательные поля Проверьте формат запроса
401 Unauthorized Неверный или отсутствующий API-ключ Проверьте ключ
403 Forbidden Ключ отключен или превышен лимит Проверьте статус ключа
429 Too Many Requests Превышен rate limit Подождите и повторите
500 Internal Server Error Ошибка на сервере Повторите позже

📌 Версионирование

API использует версионирование через URL. Текущая стабильная версия: v1

Изменения в API описаны в истории версий.

Остались вопросы по API?

Написать в поддержку Telegram