Documentation REST API

Lancez des audits SEO par programmation via l'API REST CheckSEO. Disponible sur les plans Agency et Enterprise.

Authentification

Toutes les requêtes API doivent inclure votre clé API dans l'en-tête Authorization. Créez des clés API dans les paramètres de votre compte.

Authorization: Bearer csk_your_api_key_here

Les clés API commencent par le préfixe csk_. Gardez-les secrètes — ne les exposez pas dans le code côté client.

Base URL

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

Lancer un nouvel audit SEO. Retourne audit_id pour suivre le statut.

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

Exemple

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

Interrogez cet endpoint pour vérifier la progression de l'audit. Quand le statut est "done", le champ redirect contient l'URL du rapport.

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

Télécharger le rapport d'audit en PDF. Les plans Agency/Enterprise obtiennent un PDF sans filigrane.

Flux de travail typique

1 POST /api/audits — Lancer l'audit, obtenir audit_id
2 GET /api/audits/{id}/status — Interroger toutes les 2-3 secondes jusqu'à ce que le statut soit "done"
3 GET /audits/{id} — Consulter le rapport complet
4 GET /audits/{id}/pdf — Télécharger le PDF (optionnel)

Limites de requêtes

Plan actuel Audits / mois API
Free3—
Registered5—
Pro ($19/mo)30—
Agency ($49/mo)100✓
Enterprise ($149/mo)500✓

Exemple 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)

L'accès API est disponible sur les plans Agency (49 $/mois) et Enterprise (149 $/mois).

Voir les plans