Авторизация API
Authorization: Bearer plm_live_EXAMPLE_NOT_A_REAL_KEYКлюч навсегда связан с одним ящиком. Он не открывает кабинет и не даёт доступа к другим ящикам организации.
| Право | Что разрешает |
|---|---|
emails:send | Постановка писем в очередь отправки. |
emails:status | Чтение квитанций отправки этой интеграции. |
messages:read | Чтение папок, метаданных и тела писем. |
attachments:read | Скачивание вложений и исходного MIME вместе с правом messages:read. |
По умолчанию новый ключ имеет права emails:send и emails:status. Существующим ключам чтение автоматически не добавляется. Для создания ключа с чтением нужно подтвердить пароль входа в Плиму. API изменения писем пока не предоставляется.
Хранение и отзыв
- Значение ключа показывается только при создании. Плима хранит его хеш.
- Храните секрет в серверном хранилище секретов. Не передавайте его через query string, cookie или клиентский код.
- Для каждого сайта или сервиса создавайте отдельный ключ.
- Отзывайте ненужные ключи в кабинете. Новые запросы с ними перестают приниматься.
- Отзыв отменяет ещё не начатые отправки. Передачу, которая уже началась, остановить нельзя.
Три разных секрета
- API-ключ
- Вызовы HTTPS API с выбранными правами.
- Пароль приложения
- Вход в один ящик по IMAP и/или POP3. Без SMTP.
- Секрет вебхука
- Проверка подлинности событий. Сам по себе не разрешает читать почту.
Пароль входа в Плиму служит для кабинета и подтверждения чувствительных действий. Не используйте его вместо пароля почтового приложения.
Ошибки доступа
Недействующий или отозванный ключ возвращает 401. Недостаточные права возвращают 403. Объект чужого ящика недоступен: не используйте ответ как способ искать существующие письма других пользователей.