प्रमाणीकरण
अपनी API कुंजी को Bearer टोकन के रूप में भेजें। कुंजियाँ अपने खाता सेटिंग में बनाएँ और प्रबंधित करें — पूरी कुंजी केवल एक बार निर्माण के समय दिखाई जाती है, इसलिए इसे सुरक्षित रूप से संग्रहीत करें।
Authorization: Bearer dpk_live_<selector>_<secret>कुंजियाँ dpk_<env>_<selector>_<secret> जैसी दिखती हैं, जहाँ env live या test होता है।
एक लॉग-इन ब्राउज़र सत्र समान एंडपॉइंट को कॉल कर सकता है; सत्र-प्रमाणित राइट के लिए अतिरिक्त रूप से X-CSRF-Token हेडर आवश्यक होता है। Bearer-टोकन अनुरोधों के लिए नहीं।
स्कोप और दर सीमाएँ
हर कुंजी स्कोप का एक समूह रखती है। एक कॉल ऐसी कुंजी के साथ किया जाना चाहिए जो उस एंडपॉइंट का स्कोप रखती हो। दर सीमाएँ प्रति स्कोप, प्रति कुंजी लागू होती हैं।
| स्कोप | प्रदान करता है | दर सीमा | स्तर |
|---|---|---|---|
domain.check |
Check a single .pay domain — availability + pricing | 50/sec | सार्वजनिक |
catalog.search |
AI keyword search against the curated catalog | 30/min | सार्वजनिक |
orders.read |
List + read the account's own orders | 60/min | सार्वजनिक |
orders.write |
Create a pre-order against a saved payment method | 10/min | सार्वजनिक |
payment_methods.read |
List saved cards (Stripe payment methods) | 20/min | सार्वजनिक |
payment_methods.write |
Add (SetupIntent) + remove saved cards | 20/min | सार्वजनिक |
account.read |
Read account profile: email, role, vip_tier, granted scopes | 60/min | सार्वजनिक |
webhooks.read |
List configured webhook endpoints | 20/min | सार्वजनिक |
webhooks.write |
Create + delete webhook endpoints | 10/min | सार्वजनिक |
zone_file.download |
Download the full daily .pay DNS zone-file snapshot | 24/day | प्रतिबंधित |
premium.list |
Paginated registry premium catalogue (incl. reserved/blocked) | 60/min | प्रतिबंधित |
registered.list |
Paginated registered .pay names (from the DNS zone file) + AI brand context | 60/min | प्रतिबंधित |
प्रतिबंधित स्कोप दोहरे-गेट वाले होते हैं: एक कुंजी स्कोप को सूचीबद्ध कर सकती है, लेकिन कॉल तभी सफल होते हैं जब कोई व्यवस्थापक इसे आपके खाते को प्रदान कर दे। अपने खाता सेटिंग से आवेदन करें।
समर्थित डोमेन ज़ोन
एक ही खाता और एक ही API कुंजी नीचे दिए सभी ज़ोन में काम करती है — आप जिस बेस URL को कॉल करते हैं वही ज़ोन चुनता है।
.pay |
https://domain.pay/api/v1 |
.latino |
https://domain.latino/api/v1 |
.dot |
https://domain.dot/api/v1 |
त्वरित शुरुआत
शुरू करने के लिए दो त्वरित कॉल:
# एक नाम जाँचें
curl -s https://domain.latino/api/v1/check-domain \
-H "Authorization: Bearer dpk_live_…" \
-H "Content-Type: application/json" \
-d '{"domain":"acme.latino"}'
# मैं कौन हूँ + मैं क्या कर सकता हूँ
curl -s https://domain.latino/api/v1/account \
-H "Authorization: Bearer dpk_live_…"एंडपॉइंट
सभी एंडपॉइंट सक्रिय हैं। अनुरोध और प्रतिक्रिया स्कीमा, पैरामीटर और स्थिति कोड OpenAPI दस्तावेज़ में पूरी तरह वर्णित हैं।
Account
| GET | /account |
account.read |
Your profile + the scopes effective for this key. |
Domains
| POST | /check-domain |
domain.check |
Availability + pricing for one name in a supported zone. Fast DB-only lookup (no live registry call) — POST /orders re-verifies live. |
Catalog
| POST | /catalog/search |
catalog.search |
Keyword search over the curated catalogue. |
Orders
| GET | /orders |
orders.read |
List your orders, newest first. |
| GET | /orders/{id} |
orders.read |
One order + its customer message thread. |
| POST | /orders |
orders.write |
Create a pre-order + charge a saved card (send an Idempotency-Key). |
Payment methods
| GET | /account/payment-methods |
payment_methods.read |
List saved cards. |
| POST | /account/payment-methods |
payment_methods.write |
Start a Stripe SetupIntent to add a card. |
| DELETE | /account/payment-methods/{id} |
payment_methods.write |
Remove a saved card. |
Webhooks
| GET | /webhooks |
webhooks.read |
List webhook endpoints. |
| POST | /webhooks |
webhooks.write |
Register an endpoint (signing secret shown once). |
| DELETE | /webhooks/{id} |
webhooks.write |
Delete an endpoint. |
Restricted
| GET | /zone-file |
zone_file.download |
Daily DNS zone-file snapshot for the zone of the host you call. |
| GET | /premium |
premium.list |
Registry premium catalogue. |
| GET | /registered |
registered.list |
Registered names in the called zone + AI brand context. |
पूर्ण अनुरोध/प्रतिक्रिया अनुबंध के लिए, OpenAPI स्पेक आयात करें: OpenAPI (JSON) डाउनलोड करें.
वेबहुक
एक HTTPS एंडपॉइंट पंजीकृत करें और घटनाएँ घटित होते ही हम हस्ताक्षरित इवेंट भेजते हैं। साइनिंग सीक्रेट निर्माण के समय एक बार दिखाया जाता है।
| इवेंट | विवरण |
|---|---|
order.created | A new order (pre-order) was created on the account |
order.status_changed | An order changed payment status |
payment.succeeded | A payment for an order succeeded |
payment.failed | A payment for an order failed or was canceled |
payment.refunded | A charge for an order was refunded |
appraisal.completed | A domain appraisal for an order finished |
हम इवेंट एनवेलप को JSON के रूप में POST करते हैं:
{
"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" }| HTTP | error | अर्थ |
|---|---|---|
| 400 | invalid_request | Malformed or missing parameters. |
| 401 | unauthorized / invalid_key | No or invalid credential. |
| 402 | card_declined / authentication_required | Payment failed or needs SCA. |
| 403 | scope_required | The key lacks the endpoint's scope. |
| 403 | access_not_granted | Restricted scope not yet approved for this account. |
| 403 | csrf_required | Session write without a valid X-CSRF-Token. |
| 404 | not_found | No such endpoint or resource. |
| 405 | method_not_allowed | Wrong HTTP verb. |
| 409 | request_in_progress | An idempotency key's first request is still in flight. |
| 422 | idempotency_key_reused | Same idempotency key, different parameters. |
| 422 | contact_incomplete | GA zones: add a registrant contact under /account/contacts first. |
| 423 | account_locked | Account is locked — contact support. |
| 429 | rate_limited | Slow down; see the Retry-After header. |
| 500 | server_error | Our fault. |
प्रतिबंधित पहुँच
zone-file, premium और registered एंडपॉइंट के लिए स्कोप के अतिरिक्त एक अनुमोदित ग्रांट की आवश्यकता होती है:
- प्रतिबंधित स्कोप सूचीबद्ध करने वाली एक API कुंजी बनाएँ (या पहले से रखें)।
- अपने खाता सेटिंग में, प्रतिबंधित API पहुँच खोलें, स्कोप चुनें, और बताएँ कि आप डेटा का उपयोग कैसे करेंगे।
- हमारी टीम समीक्षा करती है और आपको ईमेल द्वारा निर्णय भेजती है।
- अनुमोदन के बाद, आपके खाते की कोई भी कुंजी जो उस स्कोप को सूचीबद्ध करती है, उसका तुरंत उपयोग कर सकती है। कोई सशुल्क स्तर नहीं — अनुमोदन प्रति खाता होता है।