REST API दस्तावेज़ीकरण

CheckSEO REST API के माध्यम से प्रोग्रामेटिक रूप से SEO ऑडिट चलाएं। Agency और Enterprise प्लान पर उपलब्ध।

प्रमाणीकरण

सभी API अनुरोधों में Authorization हेडर में आपकी API कुंजी होनी चाहिए। अपनी खाता सेटिंग्स में API कुंजी बनाएं।

Authorization: Bearer csk_your_api_key_here

API कुंजी csk_ प्रीफिक्स से शुरू होती हैं। इन्हें गोपनीय रखें — क्लाइंट-साइड कोड में उजागर न करें।

Base URL

https://checkseo.site

POST /api/audits

नया SEO ऑडिट शुरू करें। स्थिति जांचने के लिए audit_id लौटाता है।

Request Body (JSON)

Field	Type	Required	Description
`url`	string	Yes	URL to audit
`lang`	string	No	Report language (en, ru, de, zh, hi, th, fr, es, cs, ar). Default: en
`skip_performance`	boolean	No	Skip Google PageSpeed check
`skip_broken_links`	boolean	No	Skip broken links check

उदाहरण

curl -X POST https://checkseo.site/api/audits \
  -H "Authorization: Bearer csk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com", "lang": "en"}'

Response (200)

{
  "audit_id": "a1b2c3d4e5f6...",
  "url": "https://example.com"
}

GET /api/audits/{audit_id}/status

ऑडिट की प्रगति जांचने के लिए इस एंडपॉइंट को पोल करें। जब स्थिति "done" हो, तो redirect फ़ील्ड में रिपोर्ट URL होता है।

Response

// In progress
{"status": "running", "step": 3, "total": 8, "percent": 37}

// Completed
{"status": "done", "redirect": "/audits/a1b2c3d4...", "percent": 100}

// Error
{"status": "error", "error_message": "...", "percent": 0}

GET /audits/{audit_id}/pdf

ऑडिट रिपोर्ट PDF के रूप में डाउनलोड करें। Agency/Enterprise प्लान पर वॉटरमार्क रहित PDF मिलता है।

सामान्य कार्यप्रवाह

1 POST /api/audits — ऑडिट शुरू करें, audit_id प्राप्त करें

2 GET /api/audits/{id}/status — हर 2-3 सेकंड पोल करें जब तक स्थिति "done" न हो

3 GET /audits/{id} — पूर्ण रिपोर्ट देखें

4 GET /audits/{id}/pdf — PDF डाउनलोड करें (वैकल्पिक)

दर सीमाएं

वर्तमान प्लान	ऑडिट / माह	API
Free	3	—
Registered	5	—
Pro ($19/mo)	30	—
Agency ($49/mo)	100	✓
Enterprise ($149/mo)	500	✓

Python उदाहरण

import requests, time

API_KEY = "csk_your_api_key"
BASE = "https://checkseo.site"
HEADERS = {"Authorization": f"Bearer {API_KEY}",
           "Content-Type": "application/json"}

# 1. Start audit
r = requests.post(f"{BASE}/api/audits",
                  json={"url": "https://example.com", "lang": "en"},
                  headers=HEADERS)
audit_id = r.json()["audit_id"]

# 2. Poll until done
while True:
    s = requests.get(f"{BASE}/api/audits/{audit_id}/status").json()
    if s["status"] == "done":
        break
    if s["status"] == "error":
        raise Exception(s["error_message"])
    time.sleep(2)

# 3. Download PDF
pdf = requests.get(f"{BASE}/audits/{audit_id}/pdf",
                   headers=HEADERS)
with open("report.pdf", "wb") as f:
    f.write(pdf.content)

API एक्सेस Agency ($49/माह) और Enterprise ($149/माह) प्लान पर उपलब्ध है।

प्लान देखें