Documentation

    Концепції, цінність і типові сценарії

    Ласкаво просимо до Ring
    Швидкий довідник
    Початок роботи
    Передумови
    Встановлення
    Валідація першого успіху
    Наступні кроки
    Функції
    Магазин
    SubscriptionConductor
    PaymentConductor
    Інтеграція платежів
    Інтеграція WayForPay
    Web3 Гаманець
    Реферальні коди (Refcodes)
    NFT Exhibition Marketplace
    Система Стейкінга Токенів
    Сутності
    Можливості
    Повідомлення
    Модуль Новин - Цифровий Газетний Досвід
    Блоги учасників
    Система Резервування Імен Користувачів
    Науковий редактор
    Notifications
    Push-сповіщення через FCM (Ring)
    Email AI-CRM
    Протокол Tunnel
    Authentication
    Безпека та відповідність
    Система локалей
    Мобільний Досвід
    Паттерни Оптимізації Продуктивності
    Приклади
    Швидкий старт
    Білий лейбл
    Інтеграція Web3
    Реальні приклади
    Кастомізація
    Швидкий старт — ваш перший клон Ring
    Повний посібник налаштування
    Брендування
    Теми
    Функції
    Локалізація
    Налаштування токеноміки
    Інтеграція платіжних шлюзів
    Еталонні деплої Ring
    Web3
    Token launch jurisdictions
    Інтеграції
    Ethereum гаманці (Wagmi v3)
    Розгортання
    Self-hosted розгортання
    Vercel
    Docker
    Конфігурація Середовища
    Моніторинг та аналітика
    Оптимізація продуктивності
    Резервне копіювання та відновлення
    Архітектура
    Data Model
    Security
    Real Time
    Архітектура PaymentConductor
    Розробка
    Ring MCP Server

    Швидкий вхід (CTO · аудитори · агенти)

    Вітаємо — місія та аудиторії
    Швидкий довідник
    Початок роботи
    Архітектура та Auth.js
    Режими бекенду та БД (DB_BACKEND_MODE)
    Self-hosted
    Ring MCP Tools
    Ring MCP Server
    Token economics
    Token launch jurisdictions
    Деплой (Docker · k8s)
    Безпека та відповідність
    ringdom.org — база LegioX
    Код — ліцензія MIT (GitHub)

    Documentation

    Концепції, цінність і типові сценарії

    Ласкаво просимо до Ring
    Швидкий довідник
    Початок роботи
    Передумови
    Встановлення
    Валідація першого успіху
    Наступні кроки
    Функції
    Магазин
    SubscriptionConductor
    PaymentConductor
    Інтеграція платежів
    Інтеграція WayForPay
    Web3 Гаманець
    Реферальні коди (Refcodes)
    NFT Exhibition Marketplace
    Система Стейкінга Токенів
    Сутності
    Можливості
    Повідомлення
    Модуль Новин - Цифровий Газетний Досвід
    Блоги учасників
    Система Резервування Імен Користувачів
    Науковий редактор
    Notifications
    Push-сповіщення через FCM (Ring)
    Email AI-CRM
    Протокол Tunnel
    Authentication
    Безпека та відповідність
    Система локалей
    Мобільний Досвід
    Паттерни Оптимізації Продуктивності
    Приклади
    Швидкий старт
    Білий лейбл
    Інтеграція Web3
    Реальні приклади
    Кастомізація
    Швидкий старт — ваш перший клон Ring
    Повний посібник налаштування
    Брендування
    Теми
    Функції
    Локалізація
    Налаштування токеноміки
    Інтеграція платіжних шлюзів
    Еталонні деплої Ring
    Web3
    Token launch jurisdictions
    Інтеграції
    Ethereum гаманці (Wagmi v3)
    Розгортання
    Self-hosted розгортання
    Vercel
    Docker
    Конфігурація Середовища
    Моніторинг та аналітика
    Оптимізація продуктивності
    Резервне копіювання та відновлення
    Архітектура
    Data Model
    Security
    Real Time
    Архітектура PaymentConductor
    Розробка
    Ring MCP Server

    Швидкий вхід (CTO · аудитори · агенти)

    Вітаємо — місія та аудиторії
    Швидкий довідник
    Початок роботи
    Архітектура та Auth.js
    Режими бекенду та БД (DB_BACKEND_MODE)
    Self-hosted
    Ring MCP Tools
    Ring MCP Server
    Token economics
    Token launch jurisdictions
    Деплой (Docker · k8s)
    Безпека та відповідність
    ringdom.org — база LegioX
    Код — ліцензія MIT (GitHub)

    Documentation

    Концепції, цінність і типові сценарії

    Ласкаво просимо до Ring
    Швидкий довідник
    Початок роботи
    Передумови
    Встановлення
    Валідація першого успіху
    Наступні кроки
    Функції
    Магазин
    SubscriptionConductor
    PaymentConductor
    Інтеграція платежів
    Інтеграція WayForPay
    Web3 Гаманець
    Реферальні коди (Refcodes)
    NFT Exhibition Marketplace
    Система Стейкінга Токенів
    Сутності
    Можливості
    Повідомлення
    Модуль Новин - Цифровий Газетний Досвід
    Блоги учасників
    Система Резервування Імен Користувачів
    Науковий редактор
    Notifications
    Push-сповіщення через FCM (Ring)
    Email AI-CRM
    Протокол Tunnel
    Authentication
    Безпека та відповідність
    Система локалей
    Мобільний Досвід
    Паттерни Оптимізації Продуктивності
    Приклади
    Швидкий старт
    Білий лейбл
    Інтеграція Web3
    Реальні приклади
    Кастомізація
    Швидкий старт — ваш перший клон Ring
    Повний посібник налаштування
    Брендування
    Теми
    Функції
    Локалізація
    Налаштування токеноміки
    Інтеграція платіжних шлюзів
    Еталонні деплої Ring
    Web3
    Token launch jurisdictions
    Інтеграції
    Ethereum гаманці (Wagmi v3)
    Розгортання
    Self-hosted розгортання
    Vercel
    Docker
    Конфігурація Середовища
    Моніторинг та аналітика
    Оптимізація продуктивності
    Резервне копіювання та відновлення
    Архітектура
    Data Model
    Security
    Real Time
    Архітектура PaymentConductor
    Розробка
    Ring MCP Server

    Швидкий вхід (CTO · аудитори · агенти)

    Вітаємо — місія та аудиторії
    Швидкий довідник
    Початок роботи
    Архітектура та Auth.js
    Режими бекенду та БД (DB_BACKEND_MODE)
    Self-hosted
    Ring MCP Tools
    Ring MCP Server
    Token economics
    Token launch jurisdictions
    Деплой (Docker · k8s)
    Безпека та відповідність
    ringdom.org — база LegioX
    Код — ліцензія MIT (GitHub)
    1. Документація
    2. /API-інтерфейс
    3. /Email AI-CRM API

    Оновлено 10 черв. 2026 р.2 хв прослуховування

    Ring Platform Logo

    Завантаження документації...

    Підготовка контенту платформи Ring

    1. Документація
    2. /API-інтерфейс
    3. /Email AI-CRM API

    Оновлено 10 черв. 2026 р.2 хв прослуховування

    Ring Platform Logo

    Завантаження документації...

    Підготовка контенту платформи Ring

    1. Документація
    2. /API-інтерфейс
    3. /Email AI-CRM API

    Оновлено 10 черв. 2026 р.2 хв прослуховування

    Ring Platform Logo

    Завантаження документації...

    Підготовка контенту платформи Ring

    Email AI-CRM API

    EN canonical: повні тіла запитів, приклади curl і JSON webhook — Email AI-CRM API (EN)

    Доступ адміна

    Усі /api/admin/email/* вимагають сесії platform admin (admin або superadmin).

    Cron / webhook

    /api/cron/* і /api/webhooks/email/inbound — CRON_SECRET або WEBHOOK_EMAIL_SECRET, не user session.

    Admin — треди

    МетодШляхОпис
    GET/api/admin/email/threadsСписок тредів; query status
    PATCH/api/admin/email/threads{ id, status }
    GET/api/admin/email/threads/[id]Тред + messages + drafts + tasks

    Admin — чернетки

    МетодШляхОпис
    GET/api/admin/email/draftsstatus: pending
    POST/api/admin/email/drafts/[id]/approveЗатвердити
    POST/api/admin/email/drafts/[id]/reject{ reason? }
    POST/api/admin/email/drafts/[id]/sendSMTP; опційно toEmail, subject

    Admin — контакти, задачі, аналітика

    МетодШляхОпис
    GET / POST/api/admin/email/contactsПошук / створення контакту
    GET / POST/api/admin/email/tasksСписок / створення задачі
    POST/api/admin/email/tasks/[id]/complete{ completionNotes? }
    GET/api/admin/email/analyticsQuery range: 7d, 30d, 90d

    Cron — email processor

    POST або GET /api/cron/email-processor

    Auth: Authorization: Bearer $CRON_SECRET

    actionПоведінка
    poll (default)pollInboundBatch() — UNSEEN → process → disconnect
    statusСтатистика процесора + IMAP
    stopЗупинити IDLE
    startIDLE (потрібен EMAIL_PROCESSOR_ALLOW_HTTP_START=true)
    mark-overdue-tasksПрострочені задачі

    GET /api/cron/email-analytics

    7-денний знімок дашборду (як admin analytics).

    Webhook — вхідна пошта

    POST /api/webhooks/email/inbound

    Auth: Bearer $WEBHOOK_EMAIL_SECRET або HMAC-SHA256 у X-Email-Webhook-Signature.

    Мінімальні поля: messageId, from, subject, bodyText. Викликає EmailProcessor.ingestEvent() з uid: 0.

    Пов’язане

    • Email AI-CRM (функція)
    • Гайд розробника
    • Admin API

    Email AI-CRM API

    EN canonical: повні тіла запитів, приклади curl і JSON webhook — Email AI-CRM API (EN)

    Доступ адміна

    Усі /api/admin/email/* вимагають сесії platform admin (admin або superadmin).

    Cron / webhook

    /api/cron/* і /api/webhooks/email/inbound — CRON_SECRET або WEBHOOK_EMAIL_SECRET, не user session.

    Admin — треди

    МетодШляхОпис
    GET/api/admin/email/threadsСписок тредів; query status
    PATCH/api/admin/email/threads{ id, status }
    GET/api/admin/email/threads/[id]Тред + messages + drafts + tasks

    Admin — чернетки

    МетодШляхОпис
    GET/api/admin/email/draftsstatus: pending
    POST/api/admin/email/drafts/[id]/approveЗатвердити
    POST/api/admin/email/drafts/[id]/reject{ reason? }
    POST/api/admin/email/drafts/[id]/sendSMTP; опційно toEmail, subject

    Admin — контакти, задачі, аналітика

    МетодШляхОпис
    GET / POST/api/admin/email/contactsПошук / створення контакту
    GET / POST/api/admin/email/tasksСписок / створення задачі
    POST/api/admin/email/tasks/[id]/complete{ completionNotes? }
    GET/api/admin/email/analyticsQuery range: 7d, 30d, 90d

    Cron — email processor

    POST або GET /api/cron/email-processor

    Auth: Authorization: Bearer $CRON_SECRET

    actionПоведінка
    poll (default)pollInboundBatch() — UNSEEN → process → disconnect
    statusСтатистика процесора + IMAP
    stopЗупинити IDLE
    startIDLE (потрібен EMAIL_PROCESSOR_ALLOW_HTTP_START=true)
    mark-overdue-tasksПрострочені задачі

    GET /api/cron/email-analytics

    7-денний знімок дашборду (як admin analytics).

    Webhook — вхідна пошта

    POST /api/webhooks/email/inbound

    Auth: Bearer $WEBHOOK_EMAIL_SECRET або HMAC-SHA256 у X-Email-Webhook-Signature.

    Мінімальні поля: messageId, from, subject, bodyText. Викликає EmailProcessor.ingestEvent() з uid: 0.

    Пов’язане

    • Email AI-CRM (функція)
    • Гайд розробника
    • Admin API

    Email AI-CRM API

    EN canonical: повні тіла запитів, приклади curl і JSON webhook — Email AI-CRM API (EN)

    Доступ адміна

    Усі /api/admin/email/* вимагають сесії platform admin (admin або superadmin).

    Cron / webhook

    /api/cron/* і /api/webhooks/email/inbound — CRON_SECRET або WEBHOOK_EMAIL_SECRET, не user session.

    Admin — треди

    МетодШляхОпис
    GET/api/admin/email/threadsСписок тредів; query status
    PATCH/api/admin/email/threads{ id, status }
    GET/api/admin/email/threads/[id]Тред + messages + drafts + tasks

    Admin — чернетки

    МетодШляхОпис
    GET/api/admin/email/draftsstatus: pending
    POST/api/admin/email/drafts/[id]/approveЗатвердити
    POST/api/admin/email/drafts/[id]/reject{ reason? }
    POST/api/admin/email/drafts/[id]/sendSMTP; опційно toEmail, subject

    Admin — контакти, задачі, аналітика

    МетодШляхОпис
    GET / POST/api/admin/email/contactsПошук / створення контакту
    GET / POST/api/admin/email/tasksСписок / створення задачі
    POST/api/admin/email/tasks/[id]/complete{ completionNotes? }
    GET/api/admin/email/analyticsQuery range: 7d, 30d, 90d

    Cron — email processor

    POST або GET /api/cron/email-processor

    Auth: Authorization: Bearer $CRON_SECRET

    actionПоведінка
    poll (default)pollInboundBatch() — UNSEEN → process → disconnect
    statusСтатистика процесора + IMAP
    stopЗупинити IDLE
    startIDLE (потрібен EMAIL_PROCESSOR_ALLOW_HTTP_START=true)
    mark-overdue-tasksПрострочені задачі

    GET /api/cron/email-analytics

    7-денний знімок дашборду (як admin analytics).

    Webhook — вхідна пошта

    POST /api/webhooks/email/inbound

    Auth: Bearer $WEBHOOK_EMAIL_SECRET або HMAC-SHA256 у X-Email-Webhook-Signature.

    Мінімальні поля: messageId, from, subject, bodyText. Викликає EmailProcessor.ingestEvent() з uid: 0.

    Пов’язане

    • Email AI-CRM (функція)
    • Гайд розробника
    • Admin API
    bash
    
    curl -X POST "$BASE_URL/api/cron/email-processor" \
      -H "Authorization: Bearer $CRON_SECRET" \
      -H "Content-Type: application/json" \
      -d '{"action":"poll"}'
    bash
    
    curl -X POST "$BASE_URL/api/cron/email-processor" \
      -H "Authorization: Bearer $CRON_SECRET" \
      -H "Content-Type: application/json" \
      -d '{"action":"poll"}'
    bash
    
    curl -X POST "$BASE_URL/api/cron/email-processor" \
      -H "Authorization: Bearer $CRON_SECRET" \
      -H "Content-Type: application/json" \
      -d '{"action":"poll"}'