API प्रलेखन
व्हाइटपेज साइट बनाएं, उनकी प्रगति का पालन करें और अपने स्वयं के कोड, नो-कोड टूल से, या बस AI असिस्टेंट से पूछकर फाइलें डाउनलोड करें। हर अनुरोध JSON के माध्यम से HTTPS पर होता है।
यह कैसे काम करता है
तीन चरण, चाहे आप कैसे भी कनेक्ट करें:
- API कुंजी बनाएं साइन इन करें, डैशबोर्ड में API कुंजियाँ खोलें और एक कुंजी बनाएं। यह आपके खाते के लिए पासवर्ड की तरह काम करता है, इसलिए इसे निजी रखें।
- साइट के लिए पूछें एक शीर्षक और एक भाषा भेजें, और यदि आप चाहें तो विषय, दर्शक और कीवर्ड भी। निर्माण मूल्य आपके बैलेंस से लिया जाएगा और साइट बनना शुरू हो जाएगी।
- अपनी साइट इकट्ठा करें यह आम तौर पर कुछ मिनटों में तैयार हो जाती है। इसकी स्थिति जाँचें, या हमसे कहें जब यह समाप्त हो जाए तो आपकी URL कॉल करें, फिर देखें, संपादित करें और फाइलें डाउनलोड करें।
चुनें कि आप कैसे कनेक्ट करते हैं
- मैं एक AI सहायक का उपयोग करता हूँ क्लॉड, ChatGPT, कर्सर और अन्य आपके लिए साइट बना सकते हैं और ट्रैक कर सकते हैं।
- मैं कोड लिखता हूँ तीन 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 कुंजी
- एक गुप्त स्ट्रिंग जो प्रमाणित करता है कि अनुरोध आपके खाते से आया है। डैशबोर्ड में कुंजी बनाएं और रद्द करें।
- बैलेंस
- आपके खाते में पूर्व-भुगतान किए गए पैसे। एक साइट बनाने पर जेनरेशन की कीमत उससे रिज़र्व हो जाती है।
- कॉलबैक
- आपका एक URL जिसे हम साइट पूरी होने पर एक बार कॉल करते हैं, ताकि आपको लगातार जांच करने की जरूरत न पड़े।
- Idempotency कुंजी
- एक लेबल जो आप अनुरोध से जोड़ते हैं ताकि इसे दो बार भेजने से कभी दो साइट्स न बनें या चार्ज न हों।
AI सहायताओं के साथ इसका उपयोग करें
एक AI सहायक को कनेक्ट करें और बस पूछें: "मेरे डेंटल क्लिनिक के लिए एक साइट बनाएं, टर्किश में।" सहायक आपके खाते के तहत वही API कॉल करता है। आप नियंत्रण में रहते हैं: साइट बनाना बैलेंस खर्च करता है, और अच्छे सहायक आपसे पूछते हैं इससे पहले कि वे ऐसा करें।
आप जो कह सकते हैं वे बातें
- मेरे पास कितना बैलेंस है, और एक साइट की कीमत क्या है?
- कौन से डिज़ाइन किट्स एक बेकरी के लिए उपयुक्त हैं?
- Alder House के लिए एक पेज की साइट बनाएं, जो एक शांत हार्बर गेस्टहाउस है, अंग्रेज़ी में।
- क्या मेरी साइट तैयार है? मुझे प्रीव्यू लिंक भेजें।
MCP (Claude, Cursor और अधिक) के माध्यम से कनेक्ट करें
MCP वह खुला स्टैंडर्ड है जिसका उपयोग असिस्टेंट बाहर के टूल कॉल करने के लिए करते हैं। अपने असिस्टेंट को MCP URL पर पॉइंट करें और अपने 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" }
}
}
}Raw 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 डेस्कटॉप mcp-remote ब्रिज के माध्यम से रिमोट सर्वर्स तक पहुंचता है, जिसके लिए Node.js की आवश्यकता होती है.
ChatGPT (कस्टम GPT)
- ChatGPT में एक GPT बनाएं, Configure खोलें और Create new action चुनें।
- Import from URL चुनें और https://whitepagekit.com/api/v1/openapi.json?profile=assistant चिपकाएं। यह ट्रिम किया गया स्कीमा केवल छह असिस्टेंट टूल रखता है।
- Authentication के तहत API key चुनें, Auth Type को Bearer सेट करें और अपनी API key चिपकाएं।
- ChatGPT आपको उन अनुरोधों की पुष्टि करने के लिए कहता है जो कुछ बदलते हैं, ताकि आप किसी भी खर्चीले बैलेंस को नियंत्रित कर सकें।
Schema URL
https://whitepagekit.com/api/v1/openapi.json?profile=assistantOpenAI API (MCP टूल)
Responses API MCP URL का उपयोग एक रिमोट टूल के रूप में कर सकता है। 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 |
मुफ्त |
कोई भी AI को ये दस्तावेज़ दें
यह पृष्ठ सादे 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 बैलेंस खर्च करता है। अन्य पांच टूल केवल पढ़ते हैं।
- एसिस्टेंट्स के लिए अलग कुंजी का उपयोग करें। इसे डैशबोर्ड में समाप्ति तिथि और दर सीमा दें, और कभी भी इसे रद्द करें।
- एसिस्टेंट्स साइट्स को हटा नहीं सकते, सेटिंग्स बदल नहीं सकते या भुगतान छू नहीं सकते: वे रूट टूल के रूप में एक्सपोज़ नहीं हैं।
- create_site पर idempotency_key सेट करें ताकि दोबारा कोशिश करने पर दो बार शुल्क न लगे। असफल निर्माणों की धनवापसी की जाती है।
- पृष्ठ संपादित करना, संदर्भ छवियाँ और जेआईपी डाउनलोड 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 स्वीकार किया गया है और नई साइट के साथ है:
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 न हो, या पोलिंग के बजाय एक कॉलबैक URL का उपयोग करें।
curl
curl https://whitepagekit.com/api/v1/sites/550e8400-e29b-41d4-a716-446655440000 \
-H "X-API-Key: YOUR_API_KEY"3. फाइलें डाउनलोड करें
एक समाप्त साइट ZIP के रूप में डाउनलोड होती है। फ़ॉर्मेट 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 जोड़ें।
इडंपोटेंसी
POST /sites पर Idempotency-Key (8–80 वर्ण: अक्षर, अंक, _ और -) भेजें। एक ही कुंजी दोहराने पर मूल साइट लौटती है और कभी भी दो बार शुल्क नहीं लगाया जाता, इसलिए टाइमआउट के बाद पुनः प्रयास सुरक्षित है। असफल निर्माण को पुनः प्रयास करने के लिए नई कुंजी का उपयोग करें।
वेबहुक्स (कॉलबैक्स)
POST /sites को callback_url पास करें (या एकाउंट वेबहुक सेट करें) और जब जॉब पूरा हो जाए (site.completed) या असफल हो जाए (site.failed) तो एक JSON POST प्राप्त करें।
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> साथ आती है, जो कि raw body का HMAC-SHA256 होता है। JSON पार्स करने से पहले, इसे constant-time तुलना से वेरिफाई करें:
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 और event द्वारा idempotently दोहरावों को संभालें। प्राइवेट-नेटवर्क टार्गेट अस्वीकृत हैं।
त्रुटियाँ
हर प्रतिक्रिया एक इनवॉल्प का उपयोग करती है। त्रुटियों में एक स्थिर कोड, स्थानीयकृत संदेश और, सत्यापन त्रुटियों के लिए, असफल क्षेत्र शामिल होता है।
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 या डेटा URL), प्रत्येक अधिकतम 10 मेगाबाइट। |
| संपादक पृष्ठ सामग्री | HTML 500,000 वर्ण तक, CSS 100,000 तक। स्क्रिप्ट और इवेंट हैंडलर हटा दिए जाते हैं। |
| साइट छवियां | PNG, JPEG, WEBP या GIF, 5 मेगाबाइट प्रति, साइट पर अधिकतम 200। |
| साइट शीर्षक | साइट शीर्षक 1–200 अक्षर। |
संपादक एपीआई
डैशबोर्ड संपादक द्वारा किए गए सभी कार्य आपके फिनिश किए गए साइटों के लिए उपलब्ध हैं: पेज सामग्री, पेज और सेक्शन योजना, स्टाइल, शीर्षक/थीम/लेआउट/संरचना, ट्रैकिंग और छवियां। पेज संपादन पेज को बदल देता है; DELETE जेनरेटेड पेज को पुनर्स्थापित करता है।
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 सच न हो। संपादन मुफ्त है।
एंडपॉइंट संदर्भ
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 से सर्वर-साइड प्रॉक्सी के माध्यम से बात करता है। एक खाता बनाएं और कुंजी प्राप्त करें, फिर प्रत्येक जेनरेशन की लागत के लिए मूल्य निर्धारण देखें।