Accessibility (WCAG) Scanner API

API Documentation

API End Points

The end point for connecting : If you subscribe directly from us use this endpoint.

	https://api.interfaces.one

Submitting the URL for scanning

POST /accessibility/scan
     parameters
             url=<url>

Should produce a result like below

{
    "success": {
        "total": 5
    },
    "contents": {
        "id": "arpt_sCsOttUEyWYQ_VNxULE8EweF",
        "status": "Accepted",
        "server_time_now": "2025-03-10T15:07:14.630535Z",
        "check_back_at": "2025-03-10T15:12:14.630541Z",
        "check_back_seconds": 300
    },
    "copyright": {
        "url": "interfaces.test",
        "year": "2025"
    }
}

Checking the status and getting the report back

POST /accessibility/scan/status
     parameters
             id=<report_id> // from above call

Should produce a result like below

{
    "success": {
        "total": 1
    },
    "contents": [
        {
            "id": "arpt_8KO3PeDPqydpd_MgivEynAeF",
            "status": "Success",
            "scan_report": "{\"url\": \"https://everythingfonts.com/\"..",
            "server_time_now": "2025-03-10T16:32:46.695341Z",
            "report_expires_at": "2025-03-10T16:37:46.695352Z"
        }
    ],
    "copyright": {
        "url": "api.interfaces.one",
        "year": "2025"
    }
}

The result field scan_report has the full encoded JSON report. Happy fixing accessibility bugs!

Ratelimiting

Some of our API calls may be public(requires free API key) , while others requires paid subscription. To maintain our serice levels both public and private API endpoints are ratelimited. Please consult your specific plan that you subscribed to for the rate limit details.

Authentication

Currently we support API Key based authentication. Please set your Autorization Bearer request header with value of your API key. Alternatively you can also pass api_key= as a request parameter, though we strongly discourage this mode of passing the key, since it will allow others to see your key.

In curl this would mean sending the Authorization header like below.

            
 curl -i <url> -H "Authorization: Bearer <api_key>"
            
            

If you are using PHP.

            
$authorization = "Authorization: Bearer <api_key>";
$ch = curl_init('<url>'); // Initialise cURL
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json' , $authorization ));
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST"); // OR GET
$result = curl_exec($ch);
curl_close($ch);
            
            

In javascript you can use headers key to add the authorization header

            
$.ajax({
   url: '<url>'
   type: 'GET',
   contentType: 'application/json'
   headers: {
      'Authorization': 'Bearer <api_key>'
   },
   success: function (result) {
       // CallBack(result);
   },
   error: function (error) {

   }
});