API الوصول إلى الويب

API الوصول إلى الويب المصمَّمة للتوسع.

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

المصادقة والمستخدم
- 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}]مصفوفة من العناصر ذات الزوج key:value لتكوينات الرأس.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}]مصفوفة من العناصر ذات الزوج key:value لتكوينات الرأس.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تنزيل التقرير بتنسيق Excel.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'

بشكلٍ افتراضي، توضِّح مستندات API لـ A11yWatch استخدام أمر curl للتفاعل مع API على بروتوكول HTTP. تسمح معظم المسارات بإرسال المعلمات من عنوان URL إلى النص. ويُفضَّل الالتزام باستخدام النص لطلب PUT وPOST على بروتوكول http لأن بعض المعلمات محدَّدة لتكون في شكل مصفوفات وأشكال أخرى غير السلاسل النصية. استبدل https://mywebsite.com في المثال بالموقع الإلكتروني الذي تريد استهدافه. يمكن يؤدي استخدام A11yWatch في الإدماج المستمر (CI) إلى توفير تكاليف التطوير بصورة جذرية عن طريق زيادة الوعي قبل نشر الإنتاج.

الثقة في الحفاظ على الشمولية

ابدأ من خلال A11yWatch الآن للحصول على أدوات سريعة بأسعار معقولة للوصول المؤتمت إلة الويب.

البدء الآن

API الوصول إلى الويب

API الوصول إلى الويب المصمَّمة للتوسع.

المصادقة والمستخدم

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

إدارة الموقع الإلكتروني

إدراج النتائج

الثقة في الحفاظ على الشمولية