Справочник API

Единый контракт для всех клиентских возможностей.

Клиентские эндпоинты доступны по пути /api/v1. Устаревший префикс /api по-прежнему доступен панели управления, но новые серверные интеграции должны использовать базовый URL с версией.

63 задокументированные операции8 групп ресурсовOpenAPI 3.1 машиночитаемый контракт

Границы аутентификации

Интеграции с продуктом используют API-ключ рабочего пространства, который также позволяет читать данные об использовании аккаунта, аналитику и метаданные API-ключей. Изменения оплаты, а также создание и отзыв API-ключей требуют HTTP-only сессии браузера и помечены соответствующим образом.

Ресурсы

8 операций

Письма и цепочки

Отправка, получение, поиск, ответы и просмотр событий доставки.

8 операций

Метки и правила сортировки

Раскладывайте отправленные и полученные письма по папкам автоматически или вручную.

9 операций

Черновики и вложения

Создавайте сценарии написания писем с приватным хранилищем вложений.

10 операций

Хранимые шаблоны

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

7 операций

Домены

Создавайте адреса отправителя и отслеживайте состояние подтверждения DNS.

8 операций

Входящая почта

Создавайте адреса и работайте с полученными переписками.

5 операций

Доставляемость

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

8 операций

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

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

Обёртка ошибок

JSON-ошибки используют одну предсказуемую обёртку. Коды состояния различают некорректный ввод, аутентификацию, отсутствующие ресурсы, конфликты, требования оплаты, блокировки безопасности и лимиты использования.

Ответ с ошибкой

{
  "error": {
    "message": "The sender domain is not verified",
    "status": 403
  }
}

Версионирование

Этот контракт идентифицируется версией API на основе даты. В рамках версии могут добавляться обратно совместимые поля. Несовместимые изменения требуют нового базового пути с версией и задокументированного перехода.

Обнаружение

{
  "version": "2026-09-07",
  "baseUrl": "https://sendhq.cc/api/v1",
  "openapi": "https://sendhq.cc/openapi.json"
}