Регламент эксплуатации

Запрос API завис. Как понять, создан ли почтовый ящик?

Автор: Alexey Bulygin
Лупа перед зелёным почтовым ящиком рядом с песочными часами

Таймаут не сообщает, успело ли выполниться создание ящика. Вашей системе нужна запись, связывающая заявку клиента с результатом. Разделите создание, настройку пересылки и готовность к работе, чтобы после обрыва связи человек не нажимал «Создать» повторно вслепую.

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

Определите, что именно нужно создавать

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

Полноценный ящик хранит собственную переписку. У него можно настроить пересылку и решить, должна ли сохраняться местная копия. Адрес пересылки без ящика нужен для другой ситуации: получать письма на одном адресе и направлять их дальше без отдельного почтового архива на этом адресе. У этих вариантов различаются условия и лимиты.

Разделите также управление почтовой системой и работу с содержимым писем. Создание адреса не требует автоматически читать переписку сотрудников. Доступ к самим сообщениям относится к отдельным возможностям API. Не выдавайте его программе, которая только создаёт ящики.

Эти различия стоит записать до начала разработки. Тогда специалисту будет понятно, какой ресурс нужно создавать и какой результат вы ожидаете увидеть в панели.

Подготовьте тариф и ограниченный доступ

Возможность настроить функцию вручную в интерфейсе не всегда означает право изменять её через API. Для создания ящиков и изменения пересылки нужны Pro или Agency. Starter допускает чтение доступной инфраструктурной конфигурации, но этого недостаточно для такой автоматизации.

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

Права сотрудника, который выдаёт доступ, тоже имеют значение. Он не может передать программе больше полномочий, чем имеет сам. Состав разрешений и тарифные границы описаны в справочнике API.

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

Соберите последовательность создания

Перед созданием определите разрешённый домен по своим данным о клиенте. Идентификатор из браузера сам по себе не подтверждает принадлежность домена.

Затем проверьте, существует ли нужный адрес и хватает ли доступных лимитов. Если ящик уже создан, сначала выясните, относится ли он к этой же заявке. Повторное нажатие кнопки сотрудником не должно приводить к неясному состоянию.

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

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

Технические методы и форматы запросов описаны в обзоре API TrekMail. Их лучше использовать как рабочую спецификацию для разработчика, сохранив пользовательский сценарий простым.

Предусмотрите повторы и ошибки

Если операция документирована как идемпотентная, сохраняйте один Idempotency-Key для той же заявки и данных. Запишите полученный ID ящика; для других действий отдельно проверьте правила повтора.

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

Отдельно обрабатывайте нехватку места, исчерпание лимита и отказ в доступе. Повтор одного и того же запроса не устранит эти причины. Пользователю полезнее увидеть понятное объяснение и ответственного за исправление, чем бесконечную надпись «Создаём ящик».

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

Проверьте процесс на одном домене

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

Затем отправьте письмо на созданный адрес. Если настроена пересылка, проверьте конечного получателя и наличие местной копии в выбранном режиме. Сам факт успешного ответа API ещё не заменяет проверку почтового сценария.

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

Используйте обзор API как технический источник. Для создания инфраструктуры не требуется читать переписку нового пользователя: выдавайте только нужные этому процессу права.

По теме

Поделиться статьёй

Вход в TrekMail

Доступ к панели, ящикам и DNS.

12 символов

Письмо отправлено

Если для этого адреса есть аккаунт, мы отправили инструкции по сбросу пароля.

Продолжая, вы принимаете Условия и Политику конфиденциальности TrekMail.