ARC API

Stop Accessibility Issues At The Source. On-demand accessibility testing that’s fully integrated into your CI/CD pipeline.

ARC API Overview

The TPG ARC API is a collection of RESTful APIs built on cutting edge AWS technology. It enables you to perform policy-based on-demand accessibility testing, fully integrated into your CI/CD platform, ensuring code successfully adheres to defined accessibility requirements. Test your code using the robust accessibility test engine that powers ARC Monitoring and view historical performance data in the ARC portal.

The ARC API also features additional APIs for registered users of the Accessibility Resource Center (ARC) Platform. ARC Platform users can use these extended APIs to view ARC configurations, access historical accessibility test results, and establish policy-based accessibility test plans for development teams.

How ARC API Empowers Organizations

 
On-Demand Testing
Allow developers to conduct on-demand accessibility testing against defined policy prior to releasing code.

Customized Testing
Configure your testing protocol for specific items or page elements using only the tests you need.

Reporting Dashboards
Integrates with ARC monitoring and visualizes testing results from the dev environment.

CI/CD Integration
RESTful API integrates with any platform that uses open APIs, including CI/CD and bug tracking software.



Features

  • The API enables policy-based accessibility testing within a CI/CD pipeline. This ensures zero tolerance, incremental improvements, and sustained performance.
  • RESTful APIs easily consumed by IDEs and popular tools, such as bug trackers.
  • On-demand accessibility analysis with the ARC Ruleset, as used within the ARC portal. Configure tests as required, using only the tests you need.
  • Historical performance in ARC Dashboards. View trends and priorities.
  • Rulesets match those used in post-production testing
  • Built on Amazon AWS Technology – Fast, Secure, and Reliable. Get Started Today!

Policy-driven Test Initiatives

With policy-driven Test Initiatives, you can quickly isolate individual assertions, select a strategy to tackle them and monitor the progress of that strategy. You can set these policies in the ARC Monitoring dashboard and utilize them through ARC API.

Policy-driven Test Initiatives consist of three main elements:

  1. A Rule. This is the particular accessibility requirement you want to address and monitor. For example, the ARC rule of ‘iframeNoTitle’ will check for iframe elements without title attributes. Often the rules will come from your domain dashboards, where you have identified your remediation priorities.
  2. A Policy. A policy is a statement of how you want to address the rule. In ARC there are three policy types:
    • Zero Tolerance – no failures allowed
    • Sustain Conformance – level of assertion failures are to remain same as in previous scan
    • Percent Improvement – set an explicit percent improvement to meet in comparison to a previous scan
  3. Baseline Scan. Progress in achieving your policy will be measured against a previous score in your ARC monitoring scans. For example, if you have 100 failures across 50 pages against the ‘iframeNoTitle’ rule in a scan, then that score can be used as your baseline for sustaining or improving over time.

Seamless CI/CD Accessibility Testing

TPG ARC Monitoring API can fully integrate with any CI/CD and DevOps software that allows for Open or RESTful APIs.
  • Jenkins
  • Docker
  • bitBucket
  • Travis CI
  • Circle CI
  • Jira
  • Atlasian
  • React
 

Apply A Proactive Testing Approach To Accessibility

Integrating accessibility into your CI/CD pipeline shifts your accessibility program management from a reactive management style to a proactive, policy-first management style.

chart showing proactive accessibility testing time distribution over a development workflow versus a reactive accessibility testing distribution


Proactive Accessibility Management
Integrating on-demand testing into your organization’s CI/CD process takes a proactive approach by testing success against the same evaluation rulesets prior to the code or content being accepted into the repository. This ensures that systems, user flows, and other digital content complies with success criteria during the early stages of the development cycle. It also ingrains accessibility methodologies into the dev-ops culture.
Reactive Accessibility Management
Many accessibility monitoring solutions, audits, and reviews present a reactive approach to accessibility management. Program managers and accessibility engineers evaluate success criteria after digital flows and content are created and are then forced to remediate existing issues. This creates an inefficient development cycle that increases time, costs, and risk exposure. Remaining in a constant state of reacting to new issues means you’ll always be one step behind.



How Is ARC API Different?

The ARC API fully integrates with TPG’s ARC Monitoring. ARC Monitoring provides the baseline datasets necessary to set policies and then the API can be used to test against them. Historical data from API testing is presented in ARC Monitoring dashboards, giving program managers full visibility into policy compliance at the earliest stages in development.

The API delivers the implementation while ARC Monitoring provides accessibility managers key insights and enables them to track and report progress. This all functions as part of TPG’s seamless accessibility management platform (ARC), which provides accessibility managers visibility and control across the entire accessibility workflow.

Additional Subscription Information

A subscription to the ARC API also includes access to the ARC Developer Portal, an online reference guide that describes how to quickly use the API to integrate accessibility testing into your software development life cycle.