CINXE.COM
WAVE Stand-alone API and Testing Engine
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>WAVE Stand-alone API and Testing Engine</title> <script type="text/javascript" src="/js/index.js"></script> <link rel="stylesheet" href="/styles/index.css?ver=3.2" type="text/css"> <link rel="shortcut icon" href="/favicon.ico"> </head> <body> <header> <nav> <ul> <li><a href="/extension">Browser Extensions</a></li> <li><a href="/standalone">Stand-alone API/Testing Engine</a></li> <li><a href="/api">Subscription API</a></li> <li><a href="/aim">AIM Report</a></li> <li><a href="/help">Help</a></li> </ul> <a href="/"><img src="/img/wavelogo.svg" alt="WAVE Web Accessibility Evaluation Tool" height="120"></a> </nav> <div id="main_form" class="controls"> <form id="waveform" novalidate> <label for="input_url">Web page address:</label><br><input id="input_url" type="url" class="control url"><input class="control" type="submit" id="button_wave" value="WAVE"> </form> </div> </header> <main> <span style="float:right;"> </span> <div style="clear:both;"></div> <h1>WAVE Stand-alone API and Testing Engine</h1> <p>Bring the power of WAVE inside your enterprise with the WAVE Stand-alone API (Application Programming Interface) and Testing Engine. When you install the WAVE API or engine locally, you can easily analyze your entire web site—plus intranet, non-public, and secure pages. Just send the API a URL or execute the testing engine, and it will return the WAVE-generated data (in JSON or XML format) about that page's accessibility.</p> <p>Use the WAVE Stand-alone API or Testing Engine to perform regularly scheduled audits of your site, integrate it into Continuous Integration processes (including headless test systems such as Selenium or Puppeteer), tie it into content authoring systems, implement it in your customized reporting or bug-tracking system, or... the sky's the limit! You'll never be tied into a pre-defined or restrictive analysis or reporting system. The stand-alone API provides you the powerful accessibility data that you can leverage in ways that work best for you.</p> <h2>Features</h2> <p>The WAVE Testing Engine is a JavaScript framework for testing content within a web browser context. It will generate a JavaScript object with details about the <a href="/api/docs?format=html">WAVE items</a> detected in the page being tested. It can easily be integrated into existing browser automation systems, such as Selenium, or be launched as a standalone testing platform using Node.js and Puppeteer. <p>The WAVE Stand-alone API analyzes pages in a self-contained, "headless" Chrome browser after scripting has been applied - full DOM analysis of a rendered web page!</p> <p>These tools support all features of the <a href="/api/details">WAVE API Specification</a>, plus the following powerful features:</p> <ul> <li>Apply scripts to interact with page content (such as triggering form errors, triggering dialogs, or loading dynamic content) before page analysis.</li> <li>Evaluation of password-protected and intranet pages. Most types of authentication are supported.</li> <li>Save the rendered page DOM. When used in conjunction with CSS Selector or XPath output values of the API, this allows you to associate a specific API error or item to a particular page element.</li> <li>Capture full-page screenshots.</li> <li>Define customized viewport sizes - handy for checking mobile responsive breakpoints.</li> <li>Off-load page loading and browser rendering to the <a href="https://browserless.io/">browserless.io</a> service. This allows running the WAVE Stand-alone API on VERY minimal hardware.</li> </ul> <p>Being an API, there will likely be programming requirements for integration with your infrastructure. It's very customizable and expandable.</p> <p>Not interested in building a system around the API? No worries! We provide several tools that use the API for general site analysis and reporting - such as a simple script for generating an easy-to-use spreadsheet of WAVE items for your entire site. This can provide a very cost-effective way of regularly auditing your site, with almost no technical or programming requirements. If you want full enterprise-level reporting out-of-the-box, check out <a href="https://pope.tech/wave">Pope Tech</a>.</p> <h2>System Requirements</h2> <p>The API will run on very minimal hardware (minimum 1CPU, 1GB memory, and 100MB storage), though will run faster and support more simultaneous requests with higher specs. The WAVE Stand-alone API runs on Linux, Mac, or Windows web servers with PHP and Node installed. Simply upload the files to a web site directory on your server, set a couple file/folder permissions, install a few dependencies, define a few configuration variables in one file, and you're up and running in minutes. To upgrade, you simply replace existing files with new ones.</p> <p>The testing engine is simply a JavaScript library that can be integrated into browser testing processes via standard Node libraries or existing browser automation systems, such as Selenium or Puppeteer.</p> <p>You can read the Stand-alone API Documentation and installation instructions at <a href="/api/SAdocs">https://wave.webaim.org/api/SAdocs</a> or documentation on the WAVE Testing Engine at <a href="/api/engine">https://wave.webaim.org/api/engine</a>. <h2>Pricing</h2> <table> <tr style="text-align: center"> <th scope="col">Version</th> <th scope="col">API Requests</th> <th scope="col">Domains</th> <th scope="col">Installations</th> <th scope="col">Data Distribution</th> <th scope="col">Annual License Fee</th> </tr> <tr> <td>Basic</td> <td>100,000</td> <td>Up to 3</td> <td>1</td> <td>Licensee only</td> <td>$4000</td> </tr> <tr> <td>Expanded</td> <td>300,000</td> <td>Up to 10</td> <td>3</td> <td>Licensee only</td> <td>$8000</td> </tr> <tr> <td>Unlimited</td> <td>Unlimited</td> <td>Unlimited</td> <td>Unlimited</td> <td>Licensee only or as authorized</td> <td>$12000</td> </tr> </table> <p>If you're interested in integrating WAVE into your own accessibility testing tools, please contact us for custom licensing details.</p> <p>Pricing is structured to reflect volume and type of usage (number of times the API is accessed, number of site domains analyzed, and number of installations) and how the API data is used.</p> <h2>Get Started</h2> <p><a href="/feedback">Contact us</a> if you're interested in licensing the Stand-alone API. We can provide a trial version of the API upon request.</p> </main> <footer> <div class="footerblock"><a href="https://usu.edu/"><img src="/img/web/usu-logo.svg" alt="Utah State University" style="width:70%";></a></div> <div class="footerblock middle"><a href="https://webaim.org/"><img src="/img/web/WebAIM-logo.svg" alt="WebAIM - Web Accessibility in Mind"></a><br>Institute for Disability Research, Policy & Practice<br> Utah State University<br> 6807 Old Main Hill<br> Logan, UT 84322-6807<br> 435.797.7024</div> <div class="footerblock" id="footerlinks"> <ul> <li id="contact"><a href="/feedback">Contact Us</a></li> <li id="sitewide"><a href="/sitewide">Site-wide WAVE Tools</a></li> <li id="about"><a href="/about">About</a></li> <li id="terms"><a href="/terms">Terms of Use</a></li> </ul> </div> <div id="copyright"> WAVE is © and ® 2024 </div> </footer> </body> </html>