Simail / РазработчикамAPI-консоль ↗

ВРЕМЕННАЯ ПОЧТА ДЛЯ АВТОМАТИЗАЦИИ

Письма и коды.
Через один API.

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

BASE URLhttps://api.apmw.net
20 минутСрок жизни по умолчанию
Bearer tokenДоступ по API-ключу
JSONЕдиный формат ответа

Три шага до первого кода

  1. Создайте ящик

    POST /api/mailbox с телом {}. Сохраните data.id и data.email.

  2. Получите OTP

    Опросите GET /api/mailbox/{id}/otp?silent=true. Пока кода нет, ответ содержит data: null.

  3. Удалите ящик

    Вызовите DELETE /api/mailbox/{id} либо дождитесь истечения срока.

curl -X POST 'https://api.apmw.net/api/mailbox' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"domain":"ikkyo.net","ttl":1200}'

В PowerShell используйте curl.exe. YOUR_API_KEY замените своим ключом.

ДОСТУП

Авторизация

Все методы работы с почтой требуют действующий ключ. Передавайте его в одном из заголовков:

Authorization: Bearer YOUR_API_KEY
# Альтернативный заголовок:
X-API-Key: YOUR_API_KEY
Документация и GET /api/health доступны без ключа. Ключ даёт доступ ко всем ящикам этого сервиса; отдельных пользовательских кабинетов и разграничения ящиков нет.

Не включайте ключ в публичный код сайта. Старый способ передачи ?api_key=… пока поддерживается для совместимости, но в новых клиентах используйте заголовок: URL может попасть в историю и журналы.

СПРАВОЧНИК

Методы API

Нажмите на метод, чтобы посмотреть параметры и пример ответа. Вместо {id} можно передать адрес email; кодируйте его через encodeURIComponent.

ЖИВОЙ ЗАПРОС

Попробовать API

Запрос отправляется на этот сервер. Ключ используется только в текущей странице и не сохраняется в браузере.

Ответ появится здесь.

АДМИНИСТРАТОРУ

Ключи и их смена

Управление доступно владельцу сервера через SSH из папки проекта. API-ключи не дают права создавать другие ключи.

rtk proxy python scripts/manage.py key list
rtk proxy python scripts/manage.py key create automation
rtk proxy python scripts/manage.py key rotate primary
rtk proxy python scripts/manage.py key revoke KEY_ID

При создании или смене новый секрет сохраняется в локальный файл secrets/api-keys/KEY_ID.env; команда сообщает путь и ID, но не печатает секрет. При смене primary обновляется также SIMAIL_API_KEY в локальном .env.

Смена действует сразу: прежний ключ получает HTTP 401. Для перехода без перерыва создайте второй ключ, обновите клиентов и затем отзовите старый.

На сервере хранится SHA256-хеш каждого ключа. Отзыв и смена применяются без перезапуска API. Восстановить секрет из списка нельзя — потерянный ключ нужно сменить. Для новой установки первоначальный ключ имеет ID primary.

ПОВЕДЕНИЕ СЕРВИСА

Ошибки и ограничения

СтатусЧто означает
200Запрос выполнен. При silent=true OTP или письмо могут ещё отсутствовать.
201Ящик создан; данные находятся в data.
400Неверный JSON, недоступный домен, некорректный prefix или ttl.
401Ключ отсутствует, неверен, сменён или отозван.
404Письмо или OTP ещё не получены либо запрошенный метод не существует.
413JSON запроса превышает 64 КиБ.
500 / 503Ошибка сервиса / нет доступных доменов. Повторите позже.