Документация API v2.4

Разработайте свой поток

MailPulse предоставляет мощный RESTful API для интеграции интеллектуальной сортировки и приоритизации в ваши собственные инструменты. Строим мосты между данными и действиями.

Схема архитектуры API MailPulse

Принципы взаимодействия

Наш API построен на стандартах HTTP и JSON. Мы используем семантические коды ответов и детализированные ошибки для быстрой отладки. Все запросы проходят через шлюз безопасности AWS WAF.

Система асинхронна по своей природе: вы отправляете задачу на анализ, а получаете результат через вебхук или по запросу статуса. Это позволяет обрабатывать миллионы писем без блокировки основного потока.

Authentication

Мы используем Bearer-токены для аутентификации всех запросов. Получите ваш ключ в панели управления разработчика.

Добавьте ваш токен в заголовок каждого запроса, как показано ниже. Токены имеют время жизни 24 часа, после чего их необходимо обновить через эндпоинт `/auth/refresh`.

🔑

API Keys

Используйте `X-MP-API-Key` для сервис-ту сервисного взаимодействия. Ключи привязаны к IP-адресам для дополнительной безопасности.

🛡️

OAuth 2.0

Для приложений, работающих от имени пользователя (например, кастомных клиентов почты), используйте наш поток авторизации PKCE.

Endpoints

Основные точки входа для управления почтовым потоком.

📥

/v2/inbox/stream

Получение приоритизированного потока входящих сообщений. Поддерживает пагинацию и фильтрацию по тегам и отправителям.

🧠

/v2/analysis/score

Запрос оценки срочности и тональности для конкретного UID письма. Возвращает JSON с метриками "тепла" и категоризацией.

🤖

/v2/actions/auto

Настройка правил автоответов и маршрутизации. Позволяет делегировать рутину скриптам на основе заданных триггеров.

📊

/v2/stats/overview

Агрегированная статистика по команде: среднее время ответа, объем непрочитанной почты, эффективность сортировки.

Rate Limits & SLA

Мы гарантируем стабильность работы для высоконагруженных систем. Лимиты зависят от выбранного тарифа.

120

Запросов в минуту (Base)

99.9%

Uptime SLA

<50ms

Средняя задержка

24/7

Поддержка DevOps

SDKs и Инструменты

Начните интеграцию быстрее с помощью официальных библиотек.

🐍

Python

Полнофункциональный SDK с поддержкой асинхронности (asyncio). Идеально для бэкенд-интеграций и Data Science задач.

💎

Ruby

Легковесная библиотека для Rails и Sinatra приложений. Простая настройка и интуитивный синтаксис.

📦

Node.js

Официальный пакет npm. Типизация TypeScript включена. Поддержка Serverless окружений (AWS Lambda).

Нужна помощь с интеграцией?

Наши инженеры готовы помочь с настройкой среды и первыми запросами.

Связаться с DevRel

Ответ в течение 24 часов