Документация API
Создавайте сайты whitepage, отслеживайте их прогресс и скачивайте файлы из собственного кода, инструмента без программирования или просто с помощью ИИ-ассистента. Каждый запрос — JSON по HTTPS.
Как это работает
Три шага, независимо от способа подключения:
- Создайте API-ключ Войдите в систему, откройте раздел API-ключи на панели управления и создайте ключ. Он работает как пароль для вашей учетной записи, поэтому храните его в тайне.
- Запросите сайт Отправьте заголовок и язык, а также, если хотите, тему, аудиторию и ключевые слова. Цена генерации списывается с вашего баланса, и начинается построение сайта.
- Соберите ваш сайт Обычно он готов в течение нескольких минут. Проверьте статус или позвольте нам уведомить ваш URL по окончании, затем просмотрите, отредактируйте и скачайте файлы.
Выберите способ подключения
- Я использую помощника ИИ Claude, ChatGPT, Cursor и другие могут создавать и отслеживать сайты для вас.
- Я пишу код Три REST вызова с примерами на curl, PHP, Node.js и Python.
- Я использую инструмент без кода Всё, что может отправлять HTTP-запрос, например Zapier, Make или n8n, может выполнять те же три вызова.
Инструменты без кода: всё, что может отправить HTTP-запрос (Zapier, Make, n8n, скрипт в таблице), может выполнять те же вызовы. POST /sites запускает создание сайта; GET /sites/{uuid} по таймеру или callback_url сообщает, когда он готов. Добавьте API-ключ в заголовок Authorization.
Ключевые термины
- Сайт
- Один сгенерированный веб-сайт со всеми его страницами. Идентифицируется с помощью uuid.
- Статус
- pending - в процессе создания, done - готов, error - ошибка создания. Ошибочный сайт автоматически возвращается.
- API-ключ
- Секретная строка, которая подтверждает, что запрос исходит из вашей учётной записи. Создавайте и отзывайте ключи в панели управления.
- Баланс
- Предоплаченные деньги на вашем счёте. Создание сайта резервирует стоимость генерации с него.
- Callback
- Ваш URL, на который мы обращаемся один раз, когда сайт готов, чтобы вам не пришлось постоянно проверять.
- Ключ идемпотентности
- Метка, которую вы прикрепляете к запросу, чтобы двойная отправка не создавала или не оплачивала два сайта.
Используйте с AI помощниками
Подключите AI ассистента и просто скажите: "Создай сайт для моей стоматологической клиники на турецком." Ассистент вызовет тот же API под вашей учётной записью. Вы остаетесь в контроле: создание сайта стоит баланса, и хорошие ассистенты спрашивают вас перед этим.
Вещи, которые вы можете сказать
- Сколько у меня баланса и сколько стоит один сайт?
- Какие дизайн-наборы подходят для пекарни?
- Создайте одностраничный сайт для Alder House, тихого гостевого дома в порту, на английском языке.
- Мой сайт готов? Отправьте мне ссылку для предварительного просмотра.
Подключитесь через MCP (Claude, Cursor и другие)
MCP — это открытый стандарт, используемый помощниками для вызова внешних инструментов. Укажите вашему помощнику URL MCP и передайте ключ API в виде токена Bearer.
Claude Code
bash
claude mcp add --transport http whitepagekit https://whitepagekit.com/api/v1/mcp \
--header "Authorization: Bearer YOUR_API_KEY"Cursor
~/.cursor/mcp.json
{
"mcpServers": {
"whitepagekit": {
"url": "https://whitepagekit.com/api/v1/mcp",
"headers": {
"Authorization": "Bearer ${env:WPK_API_KEY}"
}
}
}
}Claude Desktop
claude_desktop_config.json
{
"mcpServers": {
"whitepagekit": {
"command": "npx",
"args": ["-y", "mcp-remote", "https://whitepagekit.com/api/v1/mcp",
"--header", "Authorization:${WPK_AUTH}"],
"env": { "WPK_AUTH": "Bearer YOUR_API_KEY" }
}
}
}Чистый JSON-RPC
curl
curl -X POST https://whitepagekit.com/api/v1/mcp \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"get_account","arguments":{}}}'Claude Desktop подключается к удалённым серверам через мост mcp-remote, для которого необходим Node.js.
ChatGPT (пользовательский GPT)
- В ChatGPT создайте GPT, откройте Настройки и выберите Создать новое действие.
- Выберите Импорт из URL и вставьте https://whitepagekit.com/api/v1/openapi.json?profile=assistant. Эта сокращённая схема содержит только шесть инструментов помощника.
- В разделе Аутентификация выберите API ключ, установите Тип аутентификации на Bearer и вставьте ваш API ключ.
- ChatGPT просит подтвердить запросы, которые что-то изменяют, чтобы вы сохраняли контроль над затратами баланса.
Schema URL
https://whitepagekit.com/api/v1/openapi.json?profile=assistantOpenAI API (инструмент MCP)
API Responses может использовать URL MCP как удалённый инструмент. Параметр require_approval обеспечивает участие человека в процессе.
Python
from openai import OpenAI
client = OpenAI()
response = client.responses.create(
model="YOUR_MODEL",
tools=[{
"type": "mcp",
"server_label": "whitepagekit",
"server_url": "https://whitepagekit.com/api/v1/mcp",
"headers": {"Authorization": "Bearer YOUR_API_KEY"},
"require_approval": "always",
}],
input="What does one site cost, and which design kits suit a bakery?",
)
print(response.output_text)Ваш собственный цикл инструментов (вызов функции)
Если вы самостоятельно запускаете цикл модели, получите готовые схемы инструментов и вызывайте каждый инструмент через соответствующую REST точку. Форматы: openai (Responses API), openai-chat, anthropic и mcp.
curl
curl "https://whitepagekit.com/api/v1/ai-tools?format=openai" # or openai-chat, anthropic, mcpШесть инструментов
| Инструмент | Что он делает | Вызов REST | Стоимость |
|---|---|---|---|
get_account |
Показывает ваш баланс и сколько стоит один сайт. | GET /me |
Бесплатно |
list_languages |
Перечисляет языки, на которых может быть написан сайт. | GET /languages |
Бесплатно |
list_themes |
Ищет дизайн-наборы по теме или стилю. | GET /themes |
Бесплатно |
create_site |
Начинает генерацию сайта и снимает цену генерации с вашего баланса. | POST /sites |
Использует баланс |
get_site |
Показывает один сайт: прогресс, ссылку на предпросмотр и ссылку на загрузку. | GET /sites/{uuid} |
Бесплатно |
list_sites |
Перечисляет ваши сайты, сначала самые новые. | GET /sites |
Бесплатно |
Дайте любому ИИ эти документы
Эта страница также доступна в виде простого Markdown, идеально подходит для вставки в чат или передачи помощнику по коду:
Markdown
https://whitepagekit.com/api/v1/docs.mdПодсказка, которую вы можете вставить
Prompt
You can build websites with the White Page Kit API. Read https://whitepagekit.com/api/v1/docs.md first.
My API key is in the environment variable WPK_API_KEY.
Check my balance and the price, then create a site for my dental clinic in Izmir, in Turkish,
wait until it is ready and send me the preview link.Безопасность и стоимость
- Только create_site списывает баланс. Другие пять инструментов только читают.
- Используйте отдельный ключ для помощников. Установите срок действия и лимит скорости в панели управления и отзывайте его в любое время.
- Помощники не могут удалять сайты, менять настройки или трогать платежи: эти маршруты не представлены как инструменты.
- Устанавливайте idempotency_key при create_site, чтобы повторный запрос не списывал деньги дважды. Неудачные генерации возвращаются.
- Редактирование страниц, эталонные изображения и загрузки ZIP остаются в REST API и панели управления.
Быстрый старт
Три вызова проводят вас от брифа до скачиваемого сайта. Замените YOUR_API_KEY на ключ из панели управления.
1. Начать генерацию
POST /sites проверяет ваш бриф, резервирует стоимость генерации из вашего баланса и возвращает ответ немедленно.
curl
curl -X POST https://whitepagekit.com/api/v1/sites \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: order-1042-attempt-1" \
-d '{"title":"Alder House","lang":"en","sector":"guesthouse","keywords":"quiet stay, harbour","structure":"onepage"}'Ответ — 202 Accepted с новым сайтом:
202 Accepted
{
"success": true,
"data": {
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"status": "pending",
"title": "Alder House",
"lang": "en",
"preview_url": null,
"download_url": null
}
}2. Опрос статуса
Опросите GET /sites/{uuid} примерно каждые 5–20 секунд до статуса done или error, либо используйте callback URL вместо опроса.
curl
curl https://whitepagekit.com/api/v1/sites/550e8400-e29b-41d4-a716-446655440000 \
-H "X-API-Key: YOUR_API_KEY"3. Загрузите файлы
Готовый сайт загружается как ZIP. format — multi или onepage; assets — inline или external.
curl
curl -o site.zip \
-H "X-API-Key: YOUR_API_KEY" \
"https://whitepagekit.com/api/v1/sites/550e8400-e29b-41d4-a716-446655440000/download?format=multi&assets=inline"Тот же процесс в коде
PHP
<?php
$ch = curl_init('https://whitepagekit.com/api/v1/sites');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('WPK_API_KEY'),
'Content-Type: application/json',
'Idempotency-Key: order-1042-attempt-1',
],
CURLOPT_POSTFIELDS => json_encode(['title' => 'Alder House', 'lang' => 'en']),
]);
$site = json_decode(curl_exec($ch), true)['data'];
do {
sleep(5);
$ch = curl_init('https://whitepagekit.com/api/v1/sites/' . $site['uuid']);
curl_setopt_array($ch, [CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['X-API-Key: ' . getenv('WPK_API_KEY')]]);
$site = json_decode(curl_exec($ch), true)['data'];
} while ($site['status'] === 'pending');Node.js
const headers = {
Authorization: `Bearer ${process.env.WPK_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': 'order-1042-attempt-1',
};
let { data: site } = await (await fetch('https://whitepagekit.com/api/v1/sites', {
method: 'POST', headers,
body: JSON.stringify({ title: 'Alder House', lang: 'en' }),
})).json();
while (site.status === 'pending') {
await new Promise((r) => setTimeout(r, 5000));
({ data: site } = await (await fetch(`https://whitepagekit.com/api/v1/sites/${site.uuid}`, { headers })).json());
}Python
import os, time, requests
headers = {"Authorization": f"Bearer {os.environ['WPK_API_KEY']}",
"Idempotency-Key": "order-1042-attempt-1"}
site = requests.post("https://whitepagekit.com/api/v1/sites", headers=headers,
json={"title": "Alder House", "lang": "en"}).json()["data"]
while site["status"] == "pending":
time.sleep(5)
site = requests.get(f"https://whitepagekit.com/api/v1/sites/{site['uuid']}", headers=headers).json()["data"]Аутентификация
Отправляйте API ключ с каждым запросом, кроме документа OpenAPI. Храните ключи на сервере; никогда не помещайте их в код браузера или URL.
- Заголовок: Authorization: Bearer YOUR_API_KEY, либо X-API-Key: YOUR_API_KEY.
- Создавайте, отзывайте и ограничивайте скорость ключей в панели управления. Ключи могут иметь срок действия и список разрешённых IP.
- Вы видите только свои сайты. Сайт, принадлежащий другому аккаунту, возвращает 404 not_found.
- Добавьте ?lang=xx или Accept-Language для локализации сообщений об ошибках.
Идемпотентность
Отправляйте Idempotency-Key (8–80 символов: буквы, цифры, _ и -) при POST /sites. Повторное использование ключа возвращает исходный сайт и не списывает деньги второй раз, так что повторы после тайм-аута безопасны. Используйте новый ключ для повтора неудачной генерации.
Вебхуки (обратные вызовы)
Передайте callback_url в POST /sites (или установите вебхук аккаунта) и получите один JSON POST, когда задача завершится (site.completed) или завершится с ошибкой (site.failed).
POST callback_url
{
"event": "site.completed",
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"status": "done",
"site_title": "Alder House",
"lang": "en",
"domain": null,
"created_at": "2026-01-15T09:30:00+00:00",
"preview_url": "https://whitepagekit.com/preview?uuid=550e8400-…"
}Когда у аккаунта есть секрет вебхука, каждый запрос содержит заголовок X-Webhook-Signature: sha256=<hex>, HMAC-SHA256 исходного тела. Проверьте его перед разбором JSON, используя сравнение с постоянным временем:
PHP
$raw = file_get_contents('php://input');
$expected = 'sha256=' . hash_hmac('sha256', $raw, $webhookSecret);
if (!hash_equals($expected, $_SERVER['HTTP_X_WEBHOOK_SIGNATURE'] ?? '')) {
http_response_code(401);
exit;
}Node.js
import crypto from 'node:crypto';
const expected = 'sha256=' + crypto
.createHmac('sha256', webhookSecret).update(rawBody).digest('hex');
const received = req.get('x-webhook-signature') ?? '';
const ok = received.length === expected.length
&& crypto.timingSafeEqual(Buffer.from(received), Buffer.from(expected));Каждый обратный вызов выполняется один раз с таймаутом 10 секунд и не повторяется. Рассматривайте это как уведомление и сверяйтесь с GET /sites/{uuid}. Обрабатывайте повторы идемпотентно по uuid и событию. Целевые адреса в приватной сети отклоняются.
Ошибки
Каждый ответ использует конверт. Ошибки содержат стабильный код, локализованное сообщение и, для ошибок валидации, поле с ошибкой.
JSON
{
"success": false,
"error": {
"code": "validation_error",
"message": "...",
"details": { "field": "title" }
}
}| HTTP | Коды ошибок |
|---|---|
| 400 | validation_error, invalid_json, invalid_webhook_url |
| 401 | missing_api_key |
| 402 | insufficient_balance |
| 403 | api_disabled, invalid_api_key, forbidden |
| 404 | not_found, route_not_found |
| 405 | method_not_allowed |
| 409 | site_not_ready, conflict, edits_reset_required |
| 413 | payload_too_large |
| 415 | unsupported_media_type |
| 429 | rate_limited |
| 500 | internal_error, export_failed |
| 502 | generation_failed |
Ограничения
| Лимит | Значение |
|---|---|
| Запросы на ключ | По умолчанию 60 в минуту (настраивается для каждого ключа, 0 = без ограничений). Повторяющиеся неверные ключи с одного IP получают ответ 429 с Retry-After. |
| Тело запроса | 2 МБ; POST /sites с референс-изображениями до 162 МБ; сохранения редактора до 4 МБ. |
| Референс-изображения | До 12 PNG, JPEG или WEBP изображений (base64 или data URL), не более 10 МБ каждое. |
| Содержимое страницы редактора | HTML до 500 000 символов, CSS до 100 000. Скрипты и обработчики событий удаляются. |
| Изображения сайта | PNG, JPEG, WEBP или GIF, 5 МБ каждое, до 200 на сайт. |
| Заголовок сайта | Название сайта 1–200 символов. |
Editor API
Всё, что делает редактор панели управления, доступно и для ваших готовых сайтов: содержимое страницы, план страниц и разделов, стиль, название/тема/макет/структура, отслеживание и изображения. Редактирование страницы заменяет страницу; УДАЛЕНИЕ восстанавливает сгенерированную страницу.
curl
# Load, change and save a page
curl -H "X-API-Key: YOUR_API_KEY" \
"https://whitepagekit.com/api/v1/sites/UUID/editor?page=index"
curl -X PATCH https://whitepagekit.com/api/v1/sites/UUID/editor \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"page":"index","html":"<main>…</main>","css":""}'
# Restore the generated page
curl -X DELETE -H "X-API-Key: YOUR_API_KEY" \
"https://whitepagekit.com/api/v1/sites/UUID/editor?page=index"Для редактирования требуется завершённый сайт (иначе 409 site_not_ready). Изменение темы, макета или структуры на отредактированных страницах возвращает 409 edits_reset_required, если reset_edits не true. Редактирование бесплатно.
Справочник по эндпоинтам
Сгенерировано из документа OpenAPI, поэтому всегда соответствует актуальному API. Пути относительны базового URL.
Аккаунт
-
GET
/meGet the authenticated account
-
GET
/transactionsList account balance transactions
Каталог
-
GET
/languagesList enabled supported languages
-
GET
/themesList site themes
-
GET
/layoutsList enabled layouts
Сайты
-
GET
/sitesList the authenticated account's sites
-
POST
/sitesStart site generation
-
GET
/sites/{uuid}Get site status and refresh generation state
-
DELETE
/sites/{uuid}Delete a terminal site and its generated data — Pending, queued and running generation jobs cannot be deleted. Wait for done or error; active deletion returns 409 conflict without refunding or removing the job.
-
GET
/sites/{uuid}/downloadDownload a completed site archive
ИИ и автоматизация
-
GET
/ai-toolsFunction-calling tool schemas — The same six tools the MCP endpoint offers, as JSON schemas for your own tool loop. format is openai (Responses API), openai-chat (Chat Completions), anthropic or mcp. Public; no response envelope.
-
GET
/docs.mdDocumentation as Markdown — The developer guide, endpoint reference and AI integration guide as one Markdown file, written for language models and quick copy-paste. Public.
-
POST
/mcpModel Context Protocol endpoint — MCP over Streamable HTTP (JSON-RPC 2.0, one JSON reply per POST). Methods: initialize, ping, tools/list, tools/call. Tools: get_account, list_languages, list_themes, create_site (paid), get_site, list_sites. Authenticate with the same API key; point an MCP client at this URL.
Редактор
-
GET
/sites/{uuid}/editorLoad a page for editing — Editor access for the site owner's API key; mirrors the dashboard editor. Only completed sites (409 site_not_ready otherwise).
-
PATCH
/sites/{uuid}/editorSave a page's edited content — Replaces the page content and CSS. html must be non-empty (use DELETE to restore the generated page); scripts, event handlers and javascript: URLs are removed, HTML is limited to 500000 and CSS to 100000 characters, request body to 4 MB. Returns the saved page as GET does.
-
DELETE
/sites/{uuid}/editorRestore a page's generated content — Discards the page's saved edits. Returns the regenerated page.
-
GET
/sites/{uuid}/editor/canvasGet editing canvas data — Stylesheet, Tailwind theme, body class, direction, section blocks, icons and sample copy an external visual editor needs to render the page like the dashboard editor.
-
GET
/sites/{uuid}/pagesGet the page and section plan — Returns structure, pages with their sections and edited flag, one-page sections and the sections available to add. Same payload as the dashboard.
-
POST
/sites/{uuid}/pagesSave the page and section plan — Body: pages (list of {slug, title, nav, sections}; the first page is index) and, for onepage sites, onepage_sections. Sections of pages with saved edits are locked in the dashboard; edited pages that are removed lose their edits. At most 12 pages.
-
GET
/sites/{uuid}/styleGet style overrides — Returns stored overrides, effective colors, fonts, radius and density, and the allowed font, radius and density values.
-
POST
/sites/{uuid}/styleSave or reset style overrides — Send style ({colors, fonts: {heading, body}, radius, density}) or reset=true to return to the theme.
-
GET
/sites/{uuid}/designGet site title, theme and layout — Returns site_title, title_suggestions, theme_variant, theme_mode, layout, structure and whether the site has saved edits.
-
POST
/sites/{uuid}/designChange site title, theme, mode, layout or structure — theme_variant, theme_mode, layout and structure are required; site_title (1-200 characters), apply_blueprint and reset_edits are optional. Changing theme, layout or structure while pages have saved edits returns 409 edits_reset_required unless reset_edits is true; renaming alone keeps edits.
-
GET
/sites/{uuid}/trackingGet tracking settings
-
POST
/sites/{uuid}/trackingSave tracking settings — Body: tracking {ga4_measurement_id, google_ads_id, google_ads_conversion_label, meta_pixel_id, privacy_policy_url, terms_url}. Applied to exports; an empty object removes all tracking.
-
GET
/sites/{uuid}/mediaList uploaded site images
-
POST
/sites/{uuid}/mediaUpload or delete site images — multipart/form-data with one or more files in files[] (PNG, JPEG, WEBP or GIF, 5 MB each, at most 200 images per site), or JSON {"action": "delete", "name": <name>}. Returns the updated list for uploads. 409 conflict when the per-site image limit is reached.
Внешние платежи (только ключи администратора)
-
GET
/payment-sitesList external payment sites owned by the admin API account — Admin role required; payment.manage permission alone is insufficient. Webhook secrets are never returned.
-
POST
/payment-sitesRegister an external payment site (admin only)
-
PATCH
/payment-sites/{id}Update an owned external payment site (admin only)
-
DELETE
/payment-sites/{id}Delete an owned external payment site (admin only) — Deletion is allowed only when the site has no orders. Sites with orders must be disabled instead.
-
GET
/paymentsList external orders owned by the admin API account
-
POST
/paymentsCreate external checkout or automatic subscription (admin only) — Server-to-server only. Separate from wallet top-ups: no White Page Kit balance, bonus or referral credit. Repeated idempotency key returns the original order; a different payload or reused external order ID conflicts. Provider uncertainty never starts a second checkout automatically.
-
GET
/payments/{uuid}Read owned external payment status (admin only)
-
POST
/payments/{uuid}/cancelCancel an owned subscription or locally close a pending one-time order (admin only) — Subscriptions stop future renewals. Pending one-time cancellation is a local close, not a refund; an already-open provider checkout may still accept payment. A late authenticated real payment remains recorded and notified. No payment is marked paid by a browser return.
-
POST
/payments/{uuid}/approveApprove funds received for an owned pending or locally cancelled bank transfer (admin only) — Manual confirmation of funds received, including a transfer arriving after local cancellation; never approves a Dodo or Enigmoss order and never credits White Page Kit balance.
Описания взяты из документа OpenAPI и приведены на английском языке. Схемы запросов и ответов находятся в соответствующем файле схем.
Готовые интеграции
Набор интеграции — это небольшое PHP-приложение с формой генератора, опросом состояния, инструкциями по подписанным обратным вызовам и полноценным визуальным редактором, который общается с этим API через прокси на серверной стороне. Создайте аккаунт, чтобы получить ключ, затем ознакомьтесь с ценами на каждое создание.