API и ключи

Подключайте CRM, BI-системы и свои приложения к RFM Analyzer.

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

Создать API-ключ

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

Корпоративный тариф

Название ключаТак вы сможете быстро понять, где используется ключ.

Разрешения

Выберите действия, которые сможет выполнять интеграция.

Запуск анализаЗагружать данные и создавать задания РезультатыПолучать результаты готового анализа ЭкспортСкачивать результаты в CSV СтатистикаПросматривать квоты и журнал запросов

Важно: секретный ключ будет показан только один раз.

Ваши ключи

Загружаем список…

API v1

Быстрый старт

Передавайте ключ в заголовке X-API-Key.

3 шага

1
Создайте ключСкопируйте секрет сразу после создания.
2
Отправьте данныеПоддерживаются CSV, XLSX и JSON.
3
Получите результатПроверьте статус задания, затем запросите результат.

Пример запроса с файлом

CSV / XLSX

curl -X POST http://127.0.0.1:8000/api/v1/analyze \
  -H "X-API-Key: rfm_live_..." \
  -H "Idempotency-Key: import-2026-09-20" \
  -F "file=@transactions.csv" \
  -F "scale=5"

Подсказка: используйте уникальный Idempotency-Key, чтобы случайно не запустить одно задание дважды.

Пример запроса в формате JSON

POST /api/v1/analyze/json
{
  "transactions": [
    {"customer_id":"C-1","transaction_date":"2026-09-20","amount":1500}
  ],
  "scale": 5
}

Полезные методы

GET/api/v1/jobs/{id}Статус задания

GET/api/v1/jobs/{id}/resultsРезультат анализа

GET/api/v1/jobs/{id}/export?fmt=csvЭкспорт в CSV

GET/api/v1/usageКвоты и использование

GET/api/v1/request-logsЖурнал запросов