Управление серверами

Для чего нужен API серверов? #

В Haskimail серверы — это инструмент для организации писем, которые вы отправляете или обрабатываете. У каждого сервера есть уникальный API-токен и адрес для входящих писем. Статистика и активность сообщений также собираются по каждому серверу. Вы можете использовать это для разделения различных сред (например, рабочей и тестовой), разных клиентов или разных приложений. API /servers позволяет управлять серверами в вашем аккаунте. Для получения полной информации об этом эндпоинте, пожалуйста, обратитесь к справочнику по API серверов.

Создание сервера #

Создать сервер  с помощью API довольно просто. Ниже мы рассмотрим несколько важных моментов.

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

Серверы принадлежат аккаунту. Это отличается от привычной отправки писем, так как в Haskimail письма принадлежат конкретному серверу, а сами серверы — аккаунту. Для управления серверами вам понадобится API-токен аккаунта. Его может получить только владелец аккаунта на вкладке «Токены API» в личном кабинете Haskimail. Этот токен используется как значение HTTP-заголовка X-Haskimail-Account-Token. Этот HTTP-заголовок должен использоваться для аутентификации всех API-запросов к эндпоинту /servers. Если возникнет проблема с аутентификацией, вы получите HTTP-ответ со статус-кодом 401 (Unauthorized).

Обязательные поля

Для создания сервера требуется всего одно поле: Name. Всё, что нужно знать Haskimail, — это как вы хотите назвать сервер!

Поля ответа

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

• Поле ID важно сохранить, если вы хотите выполнять дальнейшие действия с этим сервером, например, редактировать или удалять его.
• Массив ApiTokens содержит API-токены, доступные для отправки писем с использованием этого сервера. Когда вы впервые создаете сервер, этот массив будет содержать только одну запись, но позже можно будет создать новые API-токены.

Полное управление сервером #

Используя  эндпоинт /servers , вы можете полностью управлять своим сервером. Некоторые другие важные поля, которыми вы можете управлять:

• URL вебхука для отклоненных писем: URL-адрес для отправки информации об отклоненных письмах в ваше приложение.
• URL вебхука для отслеживания открытий: URL-адрес для отправки информации об открытии писем в ваше приложение.