API Overview

Модуль Perfex CRM SaaS включает REST API для программного управления SaaS-платформой. Полезно для:

• Кастомные страницы регистрации — Собственный процесс регистрации
• Сторонние интеграции — Подключение внешних инструментов (Zapier, Integromat, кастомные приложения)
• Автоматизация биллинга — Синхронизация с внешними биллинговыми системами
• Мониторинг — Построение кастомных дашбордов и инструментов мониторинга
• Мобильные приложения — Создание мобильных интерфейсов управления

Начало работы с API

Шаг 1: Включение API

1. Перейдите в SaaS Management → SuperAdmin Settings
2. Откройте вкладку API Settings
3. Переключите API в ON
4. Сгенерируйте API-токен

Шаг 2: Аутентификация

Все API-запросы требуют аутентификации через Bearer токен в заголовке:

Authorization: Bearer YOUR_API_TOKEN_HERE

Шаг 3: Базовый URL

Базовый URL вашего API:

https://yoursite.com/api/saas/

Замените yoursite.com на ваш фактический домен.

---

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

Пример создания тенанта через API:

curl -X POST https://yoursite.com/api/saas/tenants \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "company_name": "Acme Corp",
    "email": "[email protected]",
    "first_name": "John",
    "last_name": "Doe",
    "plan_id": 1,
    "subdomain": "acme"
  }'

Response:

{
  "success": true,
  "tenant_id": 42,
  "domain": "acme.yoursite.com",
  "message": "Tenant created successfully"
}

---

Возможности API

Группа эндпоинтов	Что можно делать
Tenants	Создание, чтение, обновление, удаление тенантов
Plans	Просмотр, создание, обновление планов
Subscriptions	Управление подписками тенантов
Usage	Запрос использования и квот тенантов

Полный список эндпоинтов см. в API Reference.

---

Rate Limiting

API использует ограничение частоты запросов для защиты сервера:

• 100 запросов в минуту на каждый API-токен
• Заголовки лимита включены в каждый ответ

При превышении лимита возвращается ответ 429 Too Many Requests.

---

Рекомендации

1. Храните API-токен в секрете — Никогда не expose в клиентском коде или публичных репозиториях
2. Используйте HTTPS — Всегда делайте API-запросы через HTTPS
3. Корректно обрабатывайте ошибки — Проверяйте коды статусов и обрабатывайте ошибки
4. Кэшируйте при возможности — Не запрашивайте одни и те же данные повторно; кэшируйте ответы при редких изменениях

к сведению

Нужна кастомная интеграция? Если API не покрывает ваш сценарий, обратитесь через support. Мы постоянно расширяем API на основе обратной связи.

API Reference