التوثيق

المرجع لـ الوكلاء, MCP & API

نفّذ تقارير SEO بالذكاء الاصطناعي من موقعك، REST API، أو MCP، مع مفتاح واحد لكل شيء في أي خطة مدفوعة.

أول مرة هنا؟ صفحة المطورين تشرح نموذج الوصول قبل الانتقال إلى مرجع النقاط الطرفية. اقرأ نظرة عامة على واجهة API لتقارير SEO

المصادقة

جميع الطلبات تتطلب رمز Bearer. تتوفر مفاتيح API في الخطط المدفوعة؛ أنشئ واحدة في إعدادات حسابك. يستخدم كل موقع جديد أحد أرصدة خطتك، التي يُعاد ضبطها في اليوم الأول من كل شهر (UTC) ولا تُرحَّل.

Header· http
Authorization: Bearer sr__live_your_api_key

طلب مثال

curl· bash
curl -X POST https://seoreport.dev/api/v1/reports \
  -H "Authorization: Bearer sr__live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"url": "example.com"}'

REST API نقاط النهاية

الأساس URL: https://seoreport.dev

POST/api/v1/reports
GET/api/v1/reports/:id
GET/api/v1/reports/:id/result
GET/api/v1/reports/:id/download?format=pdf|md|txt|json
PUT/api/v1/monitors
GET/api/v1/monitors
DELETE/api/v1/monitors?url=

رد مثال

response.json· json
{
  "success": true,
  "report": {
    "jobId": "3f6c2a1e-8d4b-4c7a-9e21-5b0d7f4a6c18",
    "status": "completed",
    "targetUrl": "https://example.com"
  },
  "pollAfterMs": 0
}

قراءة النتيجة

عندما تكون قيمة report.status هي completed، تُعيد نقطة نهاية النتيجة التقرير كاملًا. توجد الملاحظات في عنصر report.view.sections الذي مفتاحه full_findings، ضمن detail.findings. تُكتب الحقول النصية بلغة التقرير.

result.json· json
{
  "success": true,
  "report": {
    "jobId": "3f6c2a1e-8d4b-4c7a-9e21-5b0d7f4a6c18",
    "status": "completed",
    "targetUrl": "https://www.example.com/",
    "auditedAt": "2026-10-11T09:14:03.000Z",
    "score": { "overall": 72 },
    "view": {
      "sections": [
        {
          "key": "full_findings",
          "state": "ready",
          "detail": {
            "findings": [
              {
                "status": "fail",
                "areaLabel": "URL signals",
                "title": "Canonical tag missing",
                "whyItMatters": "Canonical tags tell search engines which version of a page should appear in results.",
                "fix": "Add a canonical link element or Link HTTP header pointing to the preferred URL for this page."
              }
            ]
          }
        }
      ]
    }
  }
}
report.targetUrl
العنوان الذي جرى تدقيقه. تُتبَع إعادة التوجيه داخل النطاق نفسه، لذا قد يختلف عن عنوان URL الذي أرسلته.
report.auditedAt
وقت تشغيل التدقيق، بصيغة طابع زمني ISO 8601.
report.score.overall
الدرجة الإجمالية، من 0 إلى 100.
report.view.sections[].state
يبيّن ما إذا كان محتوى القسم متاحًا. تبقى قيمة detail هي null إلى أن تصبح الحالة ready.
findings[].status
نتيجة الملاحظة: fail, warn, pass, info.
findings[].areaLabel
جزء الموقع الذي تتعلق به الملاحظة.
findings[].title
الملاحظة في سطر واحد.
findings[].whyItMatters
سبب أهمية الملاحظة للظهور في البحث وفي الذكاء الاصطناعي.
findings[].fix
ما يجب تغييره. يُملأ للملاحظات الفاشلة والتحذيرية، ويبقى فارغًا لغيرها.

تحتوي النتيجة على حقول أكثر من هذه. اعتمد على الحقول المدرجة هنا؛ أما غيرها فغير موثّق وقد يتغيّر.

اتصل وكيلك بـ MCP URL