Сборка на основе Run2Mail

Developer API Documentation

Learn how to create API keys, authenticate requests, create inboxes, fetch messages, and handle common Run2Mail API responses.

Ключи API Аутентификация Основные конечные точки Коды ошибок

Ключи API

Создавайте ключи API разработчика на своей панели управления. Каждый ключ отображается полностью только один раз, а затем сохраняется в виде безопасного хеша для будущей проверки.

Создавайте ключи на панели управления, вошедшей в систему.
Держите ключи в секрете и храните их в своем секретном менеджере.
Отзывайте старые ключи, когда устройству, скрипту или товарищу по команде больше не нужен доступ.

Аутентификация

Используйте токен носителя в заголовке авторизации для каждого защищенного запроса.

Authorization: Bearer YOUR_API_KEY

Если ключ недействителен, отозван или отсутствует, API отвечает ошибкой аутентификации.

Основные конечные точки

Наиболее распространенный рабочий процесс: проверка аутентифицированного пользователя, создание почтового ящика, а затем получение сообщений из этого почтового ящика.

Проверьте текущий счет

curl -X GET "https://run2mail.com/api/v1/me" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Создать почтовый ящик

curl -X POST "https://run2mail.com/api/v1/emails/create" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "random"
  }'

Получить входящие сообщения

curl -X GET "https://run2mail.com/api/v1/emails/example@2mail.lol/messages" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Пример ответа в формате JSON

{
  "success": true,
  "data": {
    "email": "example@2mail.lol",
    "messages": []
  }
}

Ограничение скорости

Run2Mail применяет ограничения на запросы на основе плана и ежедневные ограничения на создание входящих сообщений для защиты службы и обеспечения стабильности доступа к API.

Ограничения поминутной ставки зависят от вашего активного плана.
Ограничения на создание электронной почты отслеживаются отдельно от базовых вызовов чтения.
Использование регистрируется для обеспечения видимости на панели административной аналитики.

Коды ошибок

401: Учетные данные API отсутствуют или недействительны.
403: Доступ заблокирован, ограничен или запрещен для запроса.
429: Объем запроса превысил текущий лимит.
503: API разработчика временно отключен платформой.

Скриншоты Dashboard API скоро появятся

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