واجهة برمجة تطبيقات قابلية الوصول للويب

واجهة برمجة تطبيقات قابلية الوصول للويب المصممة للتوسع.

للبدء باستخدام واجهة برمجة تطبيقات A11yWatch أضف رأس التفويض الخاص بك بتنسيق JWT Bearer TOKEN. لمزيد من المعلومات اذهب إلى توثيق OpenAPI، GraphQL، أو gRPC. تحتاج إلى اشتراك مدفوع للوصول إلى واجهة البرمجة.

التوثيق والمستخدم
- https://api.a11ywatch.com/api/user
  GET
  curl --location --request GET 'https://api.a11ywatch.com/api/user' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/login
  POST
  email stringحساب البريد الإلكتروني لتسجيل الدخول به.مطلوبpassword stringكلمة المرور للبريد الإلكتروني للتسجيل بها.مطلوب
  curl --location --request POST 'https://api.a11ywatch.com/api/login' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json' -d '{ "email": "example@email.com", "password": "somethingsafe" }'
إجراءات التقرير
- https://api.a11ywatch.com/api/scan
  POST
  url stringعنوان URL لزحف وجمع التقارير.مطلوب
  curl --location --request POST 'https://api.a11ywatch.com/api/scan' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json' -d '{ "url": "https://mywebsite.com" }'
- https://api.a11ywatch.com/api/crawl
  POST
  url stringعنوان URL لزحف وجمع التقارير.مطلوبsubdomains booleanتضمين النطاقات الفرعية التي تتطابق مع النطاق.sitemap numberتضمين روابط خريطة الموقع - 0 معطلة، 1 زحف لخريطة الموقع فقط، و 2 تمديد الزحف بخريطة الموقع.tld booleanتضمين جميع امتدادات TLD التي تتطابق مع النطاق.csv header [Accept: text/csv]معالجة البيانات كـ CSV بدلاً من JSON.
  curl --location --request POST 'https://api.a11ywatch.com/api/crawl' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json' -d '{ "url": "https://mywebsite.com" }'
- https://api.a11ywatch.com/api/websites-sync
  POST
  curl --location --request POST 'https://api.a11ywatch.com/api/websites-sync' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json'
إدارة الموقع
- https://api.a11ywatch.com/api/website
  POST
  url stringعنوان URL للموقع.مطلوبcustomHeaders string[{key: string, value: string}]مصفوفة من الكائنات مع زوج مفتاح:قيمة لتكوينات الرأس.mobile booleanهل يتم الاختبار في مشهد الجوال؟standard stringالمعيار WCAG2.1 للاستخدام مثال: WCAG2A, WCAG2AA, و WCAG2AAA.
  curl --location --request POST 'https://api.a11ywatch.com/api/website' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json' -d '{ "websiteUrl": "https://mywebsite.com" }'
- https://api.a11ywatch.com/api/website?domain=https://mywebsite.com
  GET
  url stringعنوان URL للموقع.مطلوب
  curl --location --request GET 'https://api.a11ywatch.com/api/website?domain=https://mywebsite.com' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/website
  PUT
  url stringعنوان URL للموقع.مطلوبcustomHeaders string[{key: string, value: string}]مصفوفة من الكائنات مع زوج مفتاح:قيمة لتكوينات الرأس.mobile booleanهل يتم الاختبار في مشهد الجوال؟standard stringالمعيار WCAG2.1 للاستخدام مثال: WCAG2A, WCAG2AA, و WCAG2AAA.
  curl --location --request PUT 'https://api.a11ywatch.com/api/website' --header 'Authorization: $A11YWATCH_TOKEN' -d '{ "url": "https://mywebsite.com" }'
- https://api.a11ywatch.com/api/website
  DELETE
  url عنوان URL للموقع.domain stringاسم الموقع.deleteMany booleanحذف جميع المواقع والبيانات المتعلقة.
  curl --location --request DELETE 'https://api.a11ywatch.com/api/website' --header 'Authorization: $A11YWATCH_TOKEN' -d '{ "domain": "a11ywatch.com" }'
- https://api.a11ywatch.com/api/report?url=https://mywebsite.com
  GET
  url عنوان URL لزحف وجمع التقارير.مطلوبdownload booleanتحميل التقرير إلى إكسل.csv booleanمعالجة البيانات كـ CSV بدلاً من JSON.
  curl --location --request GET 'https://api.a11ywatch.com/api/report?url=https://mywebsite.com' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/analytics?url=https://mywebsite.com
  GET
  url عنوان URL للموقع.مطلوب
  curl --location --request GET 'https://api.a11ywatch.com/api/analytics?url=https://mywebsite.com' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/website/export-pdf?url=https://mywebsite.com
  GET
  url عنوان URL لزحف وجمع التقارير.مطلوب
  curl --location --request GET 'https://api.a11ywatch.com/api/website/export-pdf?url=https://mywebsite.com' --header 'Authorization: $A11YWATCH_TOKEN'
قائمة النتائج
- https://api.a11ywatch.com/api/list/website?offset=0
  GET
  offset numberموقع الصفحة للحصول على المجموعة التالية المرقمة.search stringالبحث عن تطابق لسجل عنوان URL.
  curl --location --request GET 'https://api.a11ywatch.com/api/list/website?offset=0' --header 'Authorization: $A11YWATCH_TOKEN' undefined
- https://api.a11ywatch.com/api/list/issue?offset=0&domain=a11ywatch.com
  GET
  offset numberموقع الصفحة للحصول على المجموعة التالية المرقمة.domain stringاسم الموقع.search stringالبحث عن تطابق لسجل عنوان URL.
  curl --location --request GET 'https://api.a11ywatch.com/api/list/issue?offset=0&domain=a11ywatch.com' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/list/pages?offset=0
  GET
  offset numberموقع الصفحة للحصول على المجموعة التالية المرقمة.domain stringاسم الموقع.search stringالبحث عن تطابق لسجل عنوان URL.
  curl --location --request GET 'https://api.a11ywatch.com/api/list/pages?offset=0' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/list/analytics?offset=0&domain=a11ywatch.com
  GET
  offset numberموقع الصفحة للحصول على المجموعة التالية المرقمة.domain stringاسم الموقع.pageUrl stringعنوان URL للموقع.
  curl --location --request GET 'https://api.a11ywatch.com/api/list/analytics?offset=0&domain=a11ywatch.com' --header 'Authorization: $A11YWATCH_TOKEN'

بشكل افتراضي، توثيق واجهة برمجة تطبيقات A11yWatch يوضح استخدام curl للتفاعل مع واجهة البرمجة عبر HTTP. تسمح معظم الطرق بإرسال المعلمات من العنوان أو الجسم. من الأفضل الالتزام باستخدام الجسم لطلبات HTTP PUT و POST حيث يتم تعيين بعض المعلمات لتكون مصفوفات وأشكال أخرى غير String. في المثال، استبدل https://mywebsite.com بالموقع الذي تريد استهدافه. استخدام A11yWatch على CI يمكن أن يوفر بشكل كبير تكاليف التطوير من خلال رفع الوعي قبل نشر الإنتاج.

ظل شاملًا بثقة

ابدأ مع A11yWatch الآن بأسعار معقولة وأدوات تشغيل آلي سريعة لقابلية الويب للوصول.

ابدأ الآن

واجهة برمجة تطبيقات قابلية الوصول للويب

واجهة برمجة تطبيقات قابلية الوصول للويب المصممة للتوسع.

التوثيق والمستخدم

إجراءات التقرير

إدارة الموقع

قائمة النتائج

ظل شاملًا بثقة