К содержанию
SerpJet Документация Войти
Разделы
  1. Документация
  2. API для интеграционных партнёров

Подключить клиента, проект, баланс и integration key

Создайте пользователя (POST /users), проект для его сайта (POST /projects), выпустите ключ интеграции (POST /users/{id}/integration-key) и проверяйте баланс (GET /users/{id}/balance). Повторные вызовы с теми же внешними ID не создают дублей.

Проверено
Содержание
  1. 1. Пользователь
  2. 2. Проект
  3. 3. Ключ интеграции
  4. 4. Баланс

1. Пользователь

POST /users
{"external_user_id": "constructor-user-123", "email": "client@example.com",
 "name": "Иван Петров", "marketing_opt_in": false, "referral_code": "ABC123"}
  • Создаёт аккаунт или возвращает уже связанный с вами: "created": true/false.
  • Новому пользователю начисляются бонусные токены по обычным правилам регистрации — один раз (bonus_tokens_granted).
  • referral_code применяется только при создании. Неверный код — 400 invalid_referral_code.
  • Если почта уже занята аккаунтом, не связанным с вами, — 409 already_exists.

GET /users/{user_id} возвращает данные пользователя.

2. Проект

POST /projects
{"external_project_id": "site-456", "user_id": 1024, "name": "Сайт компании",
 "domain": "https://example.com", "description": "…", "tone_of_voice": "…",
 "target_audience": "…", "restrictions": "…", "language": "ru", "region": "225",
 "daily_article_limit": 1}

3. Ключ интеграции

  • POST /users/{user_id}/integration-key — выпускает ключ External API пользователя или возвращает существующий.
  • POST /users/{user_id}/integration-key/rotate — перевыпуск: старый ключ сразу перестаёт работать.

Ключ интеграции — тот же ключ аккаунта, что создаётся в панели, — X-Api-Key, Project ID, права и безопасная ротация ключа аккаунта.

4. Баланс

GET /users/{user_id}/balance
→ {"ok": true, "balance": {"user_id": 1024, "tokens": 8500, "estimated_articles": 4}}

estimated_articles — ориентир по средней стоимости статьи. Пополнение баланса пользователь делает в SerpJet — Пополнить картой: пакет, своя сумма и продолжение существующей оплаты.

Не нашли ответ? Напишите в поддержку из панели — укажите проект и что вы видите на экране.