Справочник API

Аккаунт и оплата

Чтение данных об использовании аккаунта, аналитики и метаданных ключей по API-ключу; изменения оплаты, создание и отзыв ключей требуют сессии панели управления.

GET/account
API-ключ

Получить аккаунт, использование, состояние оплаты и число рабочих пространств по API-ключу

Аналог профиля в панели управления для API-ключа: владелец аккаунта, использование получателей и вложений за текущий период относительно лимитов тарифа, уровень доступа, сводка репутации отправителя, состояние подписки, опубликованные тарифы и число рабочих пространств. Только чтение; изменения оплаты по-прежнему доступны только в сессии.

Запрос
curl https://sendhq.cc/api/v1/account \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Ответ 200
{
  "user": {},
  "usage": {},
  "access": {},
  "reputation": {},
  "infrastructure": {},
  "billing": {},
  "plans": [],
  "workspace": {
    "mailer": "ses",
    "stats": {}
  }
}
GET/analytics
API-ключ

Получить аналитику отправки из панели управления за 7, 30 или 90 дней

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

Параметры запросаdays
Запрос
curl https://sendhq.cc/api/v1/analytics \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Ответ 200
{
  "window": "30d",
  "days": 30,
  "metrics": {
    "sent": 0,
    "received": 0,
    "bounced": 0,
    "blocked": 0,
    "delivered": 0,
    "opened": 0,
    "clicks": 0,
    "complaints": 0
  },
  "timeline": [],
  "domains": [],
  "topContent": []
}
GET/profile
Сессия браузера

Получить аккаунт, использование и состояние совмещённых подписок

Получить аккаунт, использование и состояние совмещённых подписок

Запрос
curl https://sendhq.cc/api/v1/profile \
  -X GET \
  -H "Cookie: sendhq_session_v2=…"
Ответ 200
{
  "user": {},
  "usage": {},
  "access": {},
  "reputation": {},
  "billing": {},
  "plans": []
}
POST/billing/checkout
Сессия браузера

Начать оформление оплаты на стороне провайдера для тарифа, который ещё не подключён (уровень, класс писем и период оплаты)

Начать оформление оплаты на стороне провайдера для тарифа, который ещё не подключён (уровень, класс писем и период оплаты)

Запрос
curl https://sendhq.cc/api/v1/billing/checkout \
  -X POST \
  -H "Cookie: sendhq_session_v2=…" \
  -H "Content-Type: application/json" \
  -d '{"plan_key":"scaleup_marketing_annual"}'
Ответ 200
{
  "url": "https://checkout.example/…",
  "session_id": "…"
}
POST/billing/cancel
Сессия браузера

Отменить текущую подписку в приложении, не обращаясь к провайдеру

Отменить текущую подписку в приложении, не обращаясь к провайдеру

Запрос
curl https://sendhq.cc/api/v1/billing/cancel \
  -X POST \
  -H "Cookie: sendhq_session_v2=…"
Ответ 200
{
  "ok": true
}
POST/keys
Сессия браузера

Создать API-ключ

Создать API-ключ

Запрос
curl https://sendhq.cc/api/v1/keys \
  -X POST \
  -H "Cookie: sendhq_session_v2=…" \
  -H "Content-Type: application/json" \
  -d '{"name":"Production"}'
Ответ 201
{
  "id": "key_…",
  "name": "Production",
  "key": "re_…",
  "prefix": "re_…"
}
GET/keys
API-ключ

Список метаданных API-ключей

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

Запрос
curl https://sendhq.cc/api/v1/keys \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Ответ 200
{
  "data": [],
  "count": 0
}
DELETE/keys/:id
Сессия браузера

Отозвать API-ключ

Отозвать API-ключ

Запрос
curl https://sendhq.cc/api/v1/keys/id_value \
  -X DELETE \
  -H "Cookie: sendhq_session_v2=…"
Ответ 200
{
  "ok": true
}