XenonFlare

डेवलपर API

Site audit API — क्रॉल्स को क्यू में डालें और परिणाम प्रोग्रामैटिकली पढ़ें

रिलीज़ से पहले क्रॉल्स क्यू करें। पोल करें कि काम पूरा हुआ या नहीं, फिर रिपोर्ट लिंक फ़ेच करें—डैशबोर्ड की ज़रूरत नहीं।

Starter से शुरू करेंAPI संदर्भ

Async जॉब्स

क्रॉल्स क्यू करें, पूरा होने तक पोल करें, फिर रिपोर्ट लिंक फ़ेच करें

Site Audit API वही async job मॉडल इस्तेमाल करता है जो CI और cron इंटीग्रेशन में होता है—क्यू करने के लिए POST, पोल करने के लिए GET, और फिर स्कैन खत्म होने पर साझा रिपोर्ट्स की सूची।

Quick start (curl)

Replace $XF_API_KEY and property IDs with values from your workspace. Full reference: Developer API docs.

curl -s -X POST \
  -H "Authorization: Bearer $XF_API_KEY" \
  -H "Idempotency-Key: scan-$(date +%s)" \
  -H "Content-Type: application/json" \
  -d @scan-body.json \
  https://api.xenonflare.com/api/v1/properties/$XF_PROPERTY_ID/scans

अपना क्रॉलर बनाम XenonFlare API

इन-हाउस बनाएं जब…

  • हेडलैस ब्राउज़र्स — पॉलिटनेस क्यूज़ और क्रॉल इन्फ्रास्ट्रक्चर
  • स्कोरिंग रूल्स — इश्यू टैक्सोनॉमी और रिपोर्ट स्टोरेज
  • इंटीग्रेटर ऑथ — रेट लिमिट्स, आइडेम्पोटेंसी, और जॉब पोलिंग
  • मॉनिटरिंग — जब क्रॉलर बॉट प्रोटेक्शन या TLS समस्याओं से टकराएँ

XenonFlare का उपयोग करें जब…

  • पूरी साइट के स्कैन की क्यू — POST /properties/:id/scans के साथ
  • जॉब स्टेटस पोल करें — GET /jobs/:id के जरिए स्कोर और इश्यू काउंट देखें
  • स्कोप्ड बेयरर कीज़ — CI के लिए टेस्ट कीज़, और OpenAPI कोडजेन
  • वही क्रॉल इंजन — GSC ओवरले + API के साथ वेब ऐप जैसा

कस्टमर वर्कफ़्लो

“हम एक ही इन-हाउस डैशबोर्ड के जरिए 40 क्लाइंट साइट्स मॉनिटर करते हैं। हर रात बैच स्कैन, जब क्रॉल फेल हो तो webhook अलर्ट, और क्लाइंट रिपोर्टिंग के लिए CSV activity exports—हर प्रॉपर्टी में लॉगिन किए बिना।”

Growth पर XenonFlare Developer API का उपयोग करने वाली डिजिटल एजेंसी

  • 40 प्रॉपर्टीज़
  • POST /scans/batch
  • वेबहुक डिलीवरी हिस्ट्री
  • एक्टिविटी CSV एक्सपोर्ट

सामान्य इंटीग्रेशन फ़्लो

  1. Starter या Growth workspace बनाइए और jobs:write के साथ एक API key
  2. GET /properties के जरिए property IDs हल करें
  3. POST /properties/:id/scans के साथ एक स्कैन क्यू करें
  4. GET /jobs/:id को तब तक पोल करें जब तक स्टेटस completed या failed न हो जाए

आपको क्या मिलेगा

पूरी साइट के SEO-स्कैन जॉब्स की क्यू

स्टेटस, प्रोग्रेस और रिज़ल्ट्स पोल करें

सक्रिय साझा ऑडिट रिपोर्ट लिंक की सूची

jobs:read/write, reports:read, properties:read

Idempotency-Key

राइट रिक्वेस्ट्स पर सुरक्षित रीट्राई

रेट लिमिट्स

प्रति की 1,000 रीड/घंटा और 60 राइट/घंटा (500 ऑर्ग राइट/दिन)

FAQ

क्या एजेंसियाँ क्लाइंट्स को API एक्सेस रीसेल कर सकती हैं?

एजेंसियाँ एक Growth workspace चलाती हैं, जिसमें क्लाइंट properties एक साथ रहती हैं। डैशबोर्ड और नाइटली स्कैन के लिए स्कोप्ड कीज़ का उपयोग करें। साझा लिंक, वेबहुक्स, या अपने पोर्टल के जरिए डिलीवर करें — क्लाइंट्स को API कीज़ रखने की जरूरत नहीं होती।

Site Audit API कौन-सी प्लान में शामिल है?

डेवलपर API एक्सेस के लिए Starter या Growth चाहिए। Free प्लान में वेब ऐप और xenonflare.com के फ्री टूल्स शामिल हैं, लेकिन API कीज़ शामिल नहीं हैं।

यह फ्री ऑडिट टूल से कैसे अलग है?

फ्री टूल्स बिना अकाउंट के एक पेज का स्नैपशॉट देते हैं। API आपके workspace से जुड़ी पूरी-साइट क्रॉल क्यू करता है—जॉब हिस्ट्री, प्लान क्रॉल लिमिट्स, और शेयर करने योग्य रिपोर्ट्स के साथ।

API की रेट लिमिट्स क्या हैं?

डिफ़ॉल्ट रूप से प्रति की प्रति घंटे 1,000 रीड रिक्वेस्ट, प्रति की प्रति घंटे 60 राइट रिक्वेस्ट, और प्रति संगठन प्रति दिन 500 राइट रिक्वेस्ट। प्रति workspace अधिकतम 5 सक्रिय कीज़। विवरण के लिए Developer API docs देखें।

संबंधित

डेवलपर API डॉक्युमेंट्सOpenAPI स्पेकCI पाइपलाइन गाइडSEO ऑटोमेशन APIवेबसाइट ऑडिट प्रोडक्ट

पेड वर्कस्पेस प्लान्स पर Developer API

अपग्रेड करने के बाद वेब ऐप में API keys बनाएं। फ्री टियर में डैशबोर्ड और फ्री मार्केटिंग टूल्स शामिल हैं—REST keys नहीं।
API एक्सेस के लिए अपग्रेड करें