Core ODA API Features
Today we'll be exploring the core features offered by ODA API. From crawling websites to flexible request options and the ability to analyze various content types, ODA API empowers developers to achieve comprehensive website accessibility. Let's delve into these features in detail.
With ODA API, developers have the ability to scan entire websites on demand. By leveraging either sitemaps or manual site crawling, the site scanner examines all pages of the website for accessibility violations. As checks are completed, scan results are conveniently sent to the callback URL specified by the user, allowing for efficient handling and further analysis of the accessibility issues detected.
ODA API offers developers the flexibility to choose between synchronous and asynchronous request flows. Synchronous requests wait for ODA API to complete all accessibility checks and will then receive a response that contains all test results. Asynchronous requests receive an immediate acknowledgement; however, the response containing scan results is sent to the callback URL specified by the user once checks have completed in the background. We recommend using the synchronous request flow for smaller pages and the asynchronous flow for larger ones as any synchronous requests that take longer than 30 seconds can and will time out.
Additionally, ODA API has the ability to analyze various content sources. Developers can not only scan URLs directly but can also analyze full or partial HTML page snippets. URLs and full page snippets are checked using the full battery of accessibility tests whereas partial snippet checks exclude tests that examine the full page structure, optimizing the scanning process and providing targeted results. This versatility empowers developers to identify and address accessibility issues with precision and efficiency.
To effectively manage the accessibility of your content, we recommend either publishing content to a publicly accessible staging environment and issuing requests to ODA API with URLs referencing your staging environment, or facilitate full/partial page snippet checks programmatically before publishing content.
The core features of ODA API provide a solid foundation for assisting a variety of organizations in their pursuit of more accessible content. The ability to scan websites, flexibility in request options, and versatile content analysis capabilities provide developers with the necessary tools to comprehensively evaluate and improve website accessibility. Stay tuned for more exciting updates and insights as we continue to explore the world of web accessibility with ODA API.