توثيق REST API

قم بتشغيل تدقيقات SEO برمجياً عبر CheckSEO REST API. متاح في خطط Agency وEnterprise.

المصادقة

يجب أن تتضمن جميع طلبات API مفتاح API الخاص بك في رأس Authorization. أنشئ مفاتيح 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
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

مثال

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 على رابط التقرير.

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
Free3—
Registered5—
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/شهر).

عرض الخطط