Аккаунт
Выйти

Обзор

Интеграции

Руководство пользователя

Справочник API

Вебхуки

API Серверов

Позволяет управлять SMTP-серверами для конкретного аккаунта.

Получение информации о сервере #

get

/servers/{serverid}

Заголовки запроса

Accept обязательный

application/json
X-Haskimail-Account-Token обязательный

Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден в настройках вашего аккаунта Haskimail на вкладке «Токены API».

Пример запроса с curl

curl "https://api.haskimail.ru/servers/{serverid}" \
  -X GET \
  -H "Accept: application/json" \
  -H "X-Haskimail-Account-Token: account token"

Ответ

ID integer

ID сервера.
Name string

Название сервера.
ApiTokens array

Список API-токенов, связанных с сервером.
Color string

Цвет сервера в списке для быстрой идентификации. Возможные значения: Purple Blue Turquoise Green Red Yellow Grey Orange
SmtpApiActivated boolean

Указывает, включен ли SMTP на этом сервере.
TrackOpens boolean

Указывает, включено ли отслеживание открытий для всех писем, отправляемых через этот сервер.
TrackLinks boolean

Указывает, включено ли отслеживание ссылок для всех писем, отправляемых через этот сервер

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json

{
  "ID": 1,
  "Name": "Staging Testing",
  "ApiTokens": [
    "server token"
  ],
  "Color": "red",
  "SmtpApiActivated": true,
  "TrackOpens": false,
  "TrackLinks": false 
}

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

post

/servers

Заголовки запроса

Content-Type обязательный

application/json
Accept обязательный

application/json
X-Haskimail-Account-Token обязательный

Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден в настройках вашего аккаунта Haskimail на вкладке «Токены API».

Пример запроса с curl

curl "https://api.haskimail.ru/servers" \
  -X POST \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Haskimail-Account-Token: account token" \
  -d '{
  "Name": "Production",
  "Color": "Purple"
}'

Body format

Name string обязательный

Название сервера.
Color string

Цвет сервера в списке для быстрой идентификации. Возможные значения: Purple Blue Turquoise Green Red Yellow Grey Orange
SmtpApiActivated boolean

Указывает, включен ли SMTP на этом сервере.
TrackOpens boolean

Указывает, включено ли отслеживание открытий для всех писем, отправляемых через этот сервер.
TrackLinks boolean

Указывает, включено ли отслеживание ссылок для всех писем, отправляемых через этот сервер

Формат тела запроса

{
  "Name": "Staging Testing",
  "Color": "red",
  "SmtpApiActivated": true,
  "TrackOpens": false,
  "TrackLinks": false
}

Ответ

ID integer

ID сервера.
Name string

Название сервера.
ApiTokens array

Список API-токенов, связанных с сервером.
Color string

Цвет сервера в списке для быстрой идентификации. Возможные значения: Purple Blue Turquoise Green Red Yellow Grey Orange
SmtpApiActivated boolean

Указывает, включен ли SMTP на этом сервере.
TrackOpens boolean

Указывает, включено ли отслеживание открытий для всех писем, отправляемых через этот сервер.
TrackLinks boolean

Указывает, включено ли отслеживание ссылок для всех писем, отправляемых через этот сервер

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json

{
  "ID": 1,
  "Name": "Staging Testing",
  "ApiTokens": [
    "server token"
  ],
  "Color": "red",
  "SmtpApiActivated": true,
  "TrackOpens": false,
  "TrackLinks": false
}

Редактировать сервер #

put

/servers/{serverid}

Заголовки запроса

Content-Type обязательный

application/json
Accept обязательный

application/json
X-Haskimail-Account-Token обязательный

Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден в настройках вашего аккаунта Haskimail на вкладке «Токены API».

Пример запроса с curl

curl "https://api.haskimail.ru/servers/{serverid}" \
  -X PUT \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Haskimail-Account-Token: account token" \
  -d '{
  "Name": "Production 2",
  "Color": "Blue"
}'

Body format

Name string обязательный

Название сервера.
Color string

Цвет сервера в списке для быстрой идентификации. Возможные значения: Purple Blue Turquoise Green Red Yellow Grey Orange
SmtpApiActivated boolean

Указывает, включен ли SMTP на этом сервере.
TrackOpens boolean

Указывает, включено ли отслеживание открытий для всех писем, отправляемых через этот сервер.
TrackLinks boolean

Указывает, включено ли отслеживание ссылок для всех писем, отправляемых через этот сервер

Формат тела запроса

{
  "Name": "Production 2",
  "Color": "blue",
  "SmtpApiActivated": false,
  "TrackOpens": false,
  "TrackLinks": false
}

Ответ

ID integer

ID сервера.
Name string

Название сервера.
ApiTokens array

Список API-токенов, связанных с сервером.
Color string

Цвет сервера в списке для быстрой идентификации. Возможные значения: Purple Blue Turquoise Green Red Yellow Grey Orange
SmtpApiActivated boolean

Указывает, включен ли SMTP на этом сервере.
TrackOpens boolean

Указывает, включено ли отслеживание открытий для всех писем, отправляемых через этот сервер.
TrackLinks boolean

Указывает, включено ли отслеживание ссылок для всех писем, отправляемых через этот сервер

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json

{
  "ID": 1,
  "Name": "Production Testing",
  "ApiTokens": [
    "Server Token"
  ],
  "Color": "blue",
  "SmtpApiActivated": false,
  "TrackOpens": false,
  "TrackLinks": false
}

Список серверов #

get

/servers

Заголовки запроса

Accept обязательный

application/json
X-Haskimail-Account-Token обязательный

Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден в настройках вашего аккаунта Haskimail на вкладке «Токены API».

Пример запроса с curl

curl "https://api.haskimail.ru/servers?count=50&offset=0" \
  -X GET \
  -H "Accept: application/json" \
  -H "X-Haskimail-Account-Token: account token"

Параметры строки запроса

count integer обязательный

Количество серверов, возвращаемых в ответе.
offset integer обязательный

Количество серверов, которые нужно пропустить.
name string

Фильтрация по имени сервера. Обратите внимание, что это строковый поиск, поэтому MyServer будет соответствовать MyServer,MyServer Production и MyServer Test.

Ответ

TotalCount integer

Количество полученных серверов.
Servers array

Список серверов.
ID integer

ID сервера.
Name string

Название сервера.
ApiTokens array

Список API-токенов, связанных с сервером.
Color string

Цвет сервера в списке для быстрой идентификации. Возможные значения: Purple Blue Turquoise Green Red Yellow Grey Orange
SmtpApiActivated boolean

Указывает, включен ли SMTP на этом сервере.
TrackOpens boolean

Указывает, включено ли отслеживание открытий для всех писем, отправляемых через этот сервер.
TrackLinks boolean

Указывает, включено ли отслеживание ссылок для всех писем, отправляемых через этот сервер

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json

{
  "TotalCount": 2,
  "Servers": [
    {
      "ID": 1,
      "Name": "Production01",
      "ApiTokens": [
        "server token"
      ],
      "Color": "red",
      "SmtpApiActivated": true,
      "TrackOpens": false,
      "TrackLinks": false
    },
    {
      "ID": 2,
      "Name": "Production02",
      "ApiTokens": [
        "server token"
      ],
      "Color": "green",
      "SmtpApiActivated": true,
      "TrackOpens": true,
      "TrackLinks": true
    }
  ]
}

Удаление сервера #

Примечание: Эта функция доступна не для всех аккаунтов. Пожалуйста, свяжитесь со службой поддержки, если у вас возникнут вопросы.

delete

/servers/{serverid}

Заголовки запроса

Accept обязательный

application/json
X-Haskimail-Account-Token обязательный

Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден в настройках вашего аккаунта Haskimail на вкладке «Токены API».

Пример запроса с curl

curl "https://api.haskimail.ru/servers/{serverid}" \
  -X DELETE \
  -H "Accept: application/json" \
  -H "X-Haskimail-Account-Token: account token"

Ответ

ErrorCode integer

Коды ошибок API.
Message string

Ответ на запрос

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json

{
  "ErrorCode": 0,
  "Message": "Сервер Production Server 2 удален."
}