v1.4 · stable

Аналитика данных
без ограничений

Api-Net предоставляет простой REST API для загрузки, обработки и анализа структурированных данных. Создан для разработчиков, которым нужна надежная аналитическая инфраструктура любого масштаба.

Быстрый старт Документация API
// начало работы

Запуск за несколько минут

Свяжитесь с вашим менеджером для получения API-ключа. Все запросы должны содержать ключ в заголовке X-API-Key .

01 /

Получите API-ключ

Запросите учетные данные у назначенного менеджера. Ключи привязаны к вашему аккаунту и тарифному лимиту.

02 /

Отправьте запрос

Передавайте ключ в каждом запросе через заголовок X-API-Key . Все endpoints принимают и возвращают JSON.

03 /

Обработайте результат

Разберите JSON-ответ, обработайте ошибки по HTTP-кодам и интегрируйте данные в ваш pipeline.

// документация api

Endpoints

POST /api/v1/analyze Отправка данных на анализ
Параметр Тип Обязательный Описание
X-API-Key header обязательно API-ключ, выданный менеджером
dataset_id string обязательно Уникальный идентификатор набора данных
metrics array обязательно Список вычисляемых метрик
filters object необязательно Фильтры, применяемые перед анализом
window string необязательно Временное окно: 7d, 30d, 90d
ПРИМЕР ЗАПРОСА
curl -X POST https://api-net.duckdns.org/api/v1/analyze   -H "X-API-Key: ваш_api_ключ"   -H "Content-Type: application/json"   -d '{
    "dataset_id": "sales_q3_2024",
    "metrics": ["mean", "stddev", "percentile_95"],
    "window": "30d"
  }'
GET /api/v1/status/{job_id} Проверка статуса задачи
Параметр Тип Обязательный Описание
X-API-Key header обязательно Ваш API-ключ
job_id path обязательно ID задачи, полученный из /analyze
ПРИМЕР ЗАПРОСА
curl https://api-net.duckdns.org/api/v1/status/job_a91f3c   -H "X-API-Key: ваш_api_ключ"
GET /api/v1/quota Проверка оставшейся квоты
Параметр Тип Обязательный Описание
X-API-Key header обязательно Ваш API-ключ
ПРИМЕР ЗАПРОСА
curl https://api-net.duckdns.org/api/v1/quota   -H "X-API-Key: ваш_api_ключ"
// обработка ошибок

Коды ошибок

Все ошибки возвращают JSON с полями error и message .

HTTP Код ошибки Описание
401 missing_api_key В запросе отсутствует заголовок X-API-Key
401 invalid_api_key API-ключ недействителен или был отозван
403 quota_exceeded Исчерпан месячный лимит запросов
404 not_found Набор данных или ID задачи не найден
422 validation_error Некорректные параметры или отсутствуют обязательные поля
429 rate_limited Слишком много запросов — повторите позже
500 internal_error Внутренняя ошибка сервера
ПРИМЕР ОТВЕТА С ОШИБКОЙ
{
  "error": "invalid_api_key",
  "message": "Указанный API-ключ недействителен или был отозван. Свяжитесь с менеджером для получения нового ключа."
}