domain.dot API

Автентифікація

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

Authorization: Bearer dpk_live_<selector>_<secret>

Ключі мають вигляд dpk_<env>_<selector>_<secret>, де env — це live або test.

Активна сесія в браузері може викликати ті самі ендпоінти; для операцій запису з автентифікацією через сесію додатково потрібен заголовок X-CSRF-Token. Для запитів із токеном Bearer він не потрібен.

Області доступу та ліміти запитів

Кожен ключ має набір областей доступу. Виклик має здійснюватися ключем, що містить потрібну для ендпоінта область. Ліміти запитів застосовуються окремо для кожної області та кожного ключа.

Обмежені області доступу мають подвійний захист: ключ може містити область, але виклики спрацюють лише після того, як адміністратор надасть її вашому обліковому запису. Подайте запит у налаштуваннях облікового запису.

Підтримувані доменні зони

Один акаунт і один API-ключ працюють у всіх зонах нижче — зону визначає базовий URL, який ви викликаєте.

Швидкий старт

Два швидкі виклики для початку:

# Перевірити назву
curl -s https://domain.dot/api/v1/check-domain \
  -H "Authorization: Bearer dpk_live_…" \
  -H "Content-Type: application/json" \
  -d '{"domain":"acme.dot"}'

# Хто я і що я можу робити
curl -s https://domain.dot/api/v1/account \
  -H "Authorization: Bearer dpk_live_…"

Ендпоінти

Усі ендпоінти активні. Схеми запитів і відповідей, параметри та коди станів повністю описані в документі OpenAPI.

Account

Domains

Catalog

Orders

Payment methods

Webhooks

Restricted

Щоб отримати повний контракт запитів/відповідей, імпортуйте специфікацію OpenAPI: Завантажити OpenAPI (JSON).

Вебхуки

Зареєструйте HTTPS-ендпоінт, і ми надсилатимемо підписані події в міру їх виникнення. Секрет для підпису показується один раз під час створення.

Ми надсилаємо конверт події методом POST у форматі JSON:

{
  "id": "evt_…",
  "event": "payment.succeeded",
  "created": "2026-05-28T12:00:00+00:00",
  "data": { "order": { … } }
}

Перевіряйте кожну доставку, повторно обчислюючи HMAC-SHA256 для сирого тіла запиту за допомогою вашого секрету для підпису та порівнюючи його за сталий час:

X-Domain-Pay-Signature: sha256=<HMAC_SHA256(raw_body, signing_secret)>

Відповіді, відмінні від 2xx (або тайм-аути), повторюються з експоненційною затримкою (1 min to 24 h) до 6 спроб. Після 5 поспіль невдалих доставок ендпоінт автоматично вимикається, а власника сповіщають.

Помилки

Усі помилки мають єдину структуру. request_id повертається в кожній помилці — зазначайте його у зверненнях до підтримки.

{ "error": "scope_required", "message": "…", "request_id": "req_ab12…", "scope": "orders.read" }

Обмежений доступ

Ендпоінти zone-file, premium і registered потребують схваленого дозволу на додаток до області доступу:

1. Створіть (або майте наявний) ключ API, що містить обмежену область доступу.
2. У налаштуваннях облікового запису відкрийте розділ «Обмежений доступ до API», виберіть область і поясніть, як ви використовуватимете дані.
3. Наша команда розгляне запит і надішле вам рішення електронною поштою.
4. Після схвалення будь-який ключ вашого облікового запису, що містить цю область, зможе одразу її використовувати. Жодного платного рівня — схвалення надається для кожного облікового запису.