ПлимаДокументацияВ кабинет

Первый запрос

Создайте ключ для одного ящика и отправьте первое сервисное письмо через API Плимы.

1. Создайте ключ

В кабинете откройте «Интеграции» → «API». Выберите активный ящик и право «Отправка и статусы». Назовите ключ по вашему приложению.

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

2. Поставьте письмо в очередь

curl --request POST 'https://plima.ru/v1/emails' \
  --header "Authorization: Bearer $PLIMA_API_KEY" \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: registration-1842-code-1' \
  --data '{
    "to": "user@example.org",
    "subject": "Подтверждение регистрации",
    "text": "Ваш код: 123456",
    "expiresInSeconds": 300
  }'

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

Успех: 202 Accepted, в ответе будут id и status: "queued".

3. Получите статус

curl 'https://plima.ru/v1/emails/EMAIL_ID' \
  --header "Authorization: Bearer $PLIMA_API_KEY"

Используйте тот же ключ. Статус accepted означает, что наш почтовый сервер принял письмо. Он не подтверждает доставку во «Входящие» получателя.

Далее: все параметры отправки, чтение с пагинацией или события по вебхуку.