Dokumentace REST API

Spouštějte SEO audity programově přes REST API CheckSEO. Dostupné na plánech Agency a Enterprise.

Autentizace

Všechny API požadavky musí obsahovat váš API klíč v hlavičce Authorization. API klíče vytvořte v nastavení účtu.

Authorization: Bearer csk_your_api_key_here

API klíče začínají prefixem csk_. Uchovávejte je v tajnosti — nevystavujte je v klientském kódu.

Base URL

https://checkseo.site
POST /api/audits

Spustit nový SEO audit. Vrátí audit_id pro sledování stavu.

Request Body (JSON)

Field Type Required Description
urlstringYesURL to audit
langstringNoReport language (en, ru, de, zh, hi, th, fr, es, cs, ar). Default: en
skip_performancebooleanNoSkip Google PageSpeed check
skip_broken_linksbooleanNoSkip broken links check

Příklad

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

Dotazujte tento endpoint pro kontrolu průběhu auditu. Když je stav "done", pole redirect obsahuje URL reportu.

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

Stáhnout audit report jako PDF. Plány Agency/Enterprise získají čisté PDF bez vodoznaku.

Typický pracovní postup

1 POST /api/audits — Spustit audit, získat audit_id
2 GET /api/audits/{id}/status — Dotazovat každé 2-3 sekundy, dokud stav není "done"
3 GET /audits/{id} — Zobrazit úplný report
4 GET /audits/{id}/pdf — Stáhnout PDF (volitelné)

Limity požadavků

Aktuální plán Audity / měsíc API
Free3—
Registered5—
Pro ($19/mo)30—
Agency ($49/mo)100✓
Enterprise ($149/mo)500✓

Příklad v Pythonu

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)

Přístup k API je dostupný na plánech Agency ($49/měs.) a Enterprise ($149/měs.).

Zobrazit plány