واجهة WebsiteCoach API

استخدم واجهة WebsiteCoach API لجلب تقارير المواقع المخزنة وعناصر العمل ذات الأولوية للوحات الداخلية وبوابات العملاء والأتمتة.

Ludwig Makhyan · المؤسس, WebsiteCoach

انتقل إلى القسم

نظرة عامة نقاط النهاية الأمان الحدود

ما الغرض من واجهة WebsiteCoach API

تمنح واجهة WebsiteCoach API المستخدمين المسجلين وصولا برمجيا إلى بيانات التقارير نفسها التي تظهر في التطبيق. وهي مناسبة للوحات الداخلية وبوابات العملاء وسير عمل التقارير وأدوات الأتمتة التي تحتاج إلى بيانات صحة الموقع بصيغة JSON.

تتجنب الوثائق العامة عمدا كشف الرموز الخاصة أو تفاصيل التنفيذ الداخلية أو المسارات الخاصة بالمديرين أو إعدادات الزحف الحساسة. ينشئ المستخدمون رموز API الخاصة بهم ويديرونها من منطقة الملف الشخصي بعد تسجيل الدخول.

تقرير JSON مخزن

اجلب أحدث تقرير محفوظ لنطاق، بما في ذلك الدرجات والمقاييس والأقسام وحقول الأدلة.

نقطة نهاية عناصر العمل

اسحب قائمة الإصلاحات ذات الأولوية فقط، بما في ذلك الأولوية والقسم والوصف والمقياس والهدف ومستوى الثقة.

مطالبات إصلاح بالذكاء الاصطناعي

اجلب مطالبات جاهزة للنسخ إلى أدوات البرمجة بالذكاء الاصطناعي، مع أدلة التدقيق وعناوين URL وروابط التعلم وتعليمات يدوية للإصلاحات من جهة المزوّد.

وصول مرتبط بالسجل

ترتبط مشاهدات تقارير API بالمستخدم المصادق عليه، لذلك تظهر النطاقات نفسها في سجل الحساب وسجل الإدارة.

التحكم في الرموز

يمكن للمستخدمين إنشاء رموز منفصلة لأدوات مختلفة وإلغاء رمز دون كشف كلمات المرور أو الجلسات.

نقاط نهاية API العامة

التقرير المخزن الكامل

استخدم هذا عندما يحتاج تطبيقك إلى التقرير المحفوظ الكامل لنطاق.

GET https://websitecoach.com/api/reports?url=example.com&token=YOUR_TOKEN&lang=en

عناصر العمل فقط

استخدم هذا لإنشاء التذاكر أو لوحات المديرين أو التكاملات التي تحتاج فقط إلى قائمة الإصلاحات ذات الأولوية.

GET https://websitecoach.com/api/actionitems?url=example.com&token=YOUR_TOKEN&lang=en

Payloads إصلاح بالذكاء الاصطناعي

استخدم هذا عندما يرسل سير عملك نتائج WebsiteCoach إلى ChatGPT أو Claude أو Gemini أو Cursor أو أي مساعد برمجة بالذكاء الاصطناعي.

GET https://websitecoach.com/api/payload?url=example.com&token=YOUR_TOKEN

تُرجع الاستجابة كل عنصر إجراء مع القسم والأولوية ورابط التعلم وأدلة التدقيق ومطالبة منظّمة. تطلب المطالبات من الذكاء الاصطناعي فحص بنية المستخدم أولاً، وعندما يكون الإصلاح في DNS أو CDN أو البريد الإلكتروني أو المسجّل أو CMS أو لوحة خارجية أخرى، تقديم دليل يدوي مفصل بدلاً من اختراع تغييرات في الكود.

تنسيق رمز Bearer

يمكن لتطبيقات الخادم إرسال الرمز في ترويسة Authorization بدلا من سلسلة الاستعلام.

Authorization: Bearer YOUR_TOKEN

أمان الرموز والبيانات

احتفظ بالرموز على الخادم

لا تضع رموز API في JavaScript عام أو تطبيقات جوال أو لقطات شاشة أو مستندات مشتركة.
أنشئ رموزا منفصلة لكل تطبيق حتى يمكن إلغاء تكامل واحد دون تعطيل الآخرين.
استخدم HTTPS فقط ودوّر الرموز عندما لا يحتاج زميل أو مورّد أو نظام إلى الوصول.
تعيد الواجهة فقط بيانات التقارير المتاحة لصاحب الرمز المصادق عليه؛ ولا تكشف كلمات المرور أو الجلسات أو أسرار الفوترة أو مسارات الإدارة أو ترويسات الزحف الخاصة.

الوصول والحدود

يتوفر وصول API للمستخدمين المسجلين. يمكن لكل مستخدم إنشاء ما يصل إلى 10 رموز API نشطة من ملفه الشخصي.

صممت استدعاءات API لاسترجاع التقارير المخزنة وسير عمل عناصر العمل. قد يتغير سلوك الفحوصات الجديدة والتحديثات المعتمدة على الرصيد، لذلك يجب أن تعتمد التكاملات العامة على نقاط النهاية الموثقة للتقارير وعناصر العمل.

لإنشاء الرموز أو إلغائها، سجل الدخول وافتح API tokens.

هل تحتاج إلى تكامل خاص؟

لحالات الشركاء أو المؤسسات، تواصل مع WebsiteCoach قبل البناء على سلوك غير عام. الوثائق العامة هي العقد المستقر.

تحقق من نقاط website الخاصة بك الآن

تدقيق مجاني خلال 60 ثانية - لا يلزم وجود حساب.

تشغيل التدقيق المجاني