Разработчикам

Документация API

Строгий, типизированный интерфейс для интеграции с экосистемой UniFly. Строим архитектуру будущего с акцентом на безопасность и скорость.

Начать интеграцию Справочник методов
Быстрый старт

Первые шаги

UniFly API построен по принципам RESTful архитектуры. Все запросы отправляются на базовый URL https://api.unifly.io/v1/ и требуют заголовка Content-Type: application/json.

Проверка статуса системы

Используйте этот метод для проверки доступности узлов и времени отклика перед началом массовой обработки данных.

GET /system/status
// Response 200 OK
{
  "status": "operational",
  "latency_ms": 24,
  "version": "v1.4.2"
}
Безопасность

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

Доступ к API осуществляется через Bearer-токены (OAuth 2.0). Ключи генерируются в панели администратора и имеют привязку к IP-адресам.

Убедитесь, что вы используете HTTPS для всех запросов. Токены с истекшим сроком действия возвращают код 401 Unauthorized.

🔐

Заголовок запроса

Authorization: Bearer your_api_key_here

Ограничения (Rate Limiting)

  • Базовый план 60 req/min
  • Business 1000 req/min
  • Enterprise Безлимит
Data Layer

Основы работы с данными

Стандартизированные модели для аналитических объектов

Методы (GET)

Извлечение сырых данных из хранилищ. Поддерживает фильтрацию по временным диапазонам и сегментам.

GET /v1/analytics/metrics

Создание (POST)

Передача метрик событий в реальном времени. Асинхронная обработка гарантирует отсутствие блокировок.

POST /v1/events/ingest

Обновление (PATCH)

Корректировка метаданных отчетов и настроек дашбордов без перезаписи всей структуры.

PATCH /v1/reports/{id}
Real-time

Webhooks и уведомления

Настройте конечные точки для мгновенного реагирования на критические события в вашей бизнес-логике. UniFly отправляет POST-запросы при срабатывании триггеров.

  • Аномалии в конверсии
  • Завершение ETL-процессов
  • Ошибки интеграции
Документация событий

Пример полезной нагрузки

{
  "event": "anomaly_detected",
  "timestamp": "2023-10-24T14:30:00Z",
  "data": {
    "metric": "conversion_rate",
    "deviation": -14.5,
    "severity": "high"
  }
}
SDK

Примеры кода

Python

import unifly

client = unifly.Client(api_key=API_KEY)

def get_metrics():
  response = client.analytics.get(
    metric='revenue',
    period='last_30d'
  )
  return response.data

JavaScript (Node.js)

const { UniFly } = require('unifly-sdk');

async function init() {
  const client = new UniFly(API_KEY);
  const data = await client.metrics.fetch({
    type: 'engagement'
  });
  console.log(data);
}

Нужна помощь с интеграцией?

Наша команда инженерной поддержки доступна для Enterprise-клиентов для помощи в настройке сложных конвейеров данных.

Связаться с DevRel Статус API