a11ywatch_client

a11ywatch_client

A11ywatchClient - JavaScript client for a11ywatch_client The web accessibility tool built for scale. This SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.7.66
• Package version: 0.7.66
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://a11ywatch.com/contact

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install a11ywatch_client --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your a11ywatch_client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var A11ywatchClient = require('a11ywatch_client');

var defaultClient = A11ywatchClient.ApiClient.instance;
// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

var api = new A11ywatchClient.CollectionApi()
var opts = {
  'offset': "offset_example", // {String} The page offset for the next set
  'domain': "domain_example" // {String} Domain of website that needs to be fetched
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAnalytics(opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api.a11ywatch.com/api

Class	Method	HTTP request	Description
A11ywatchClient.CollectionApi	getAnalytics	GET /list/analytics	Get the analytics for a website
A11ywatchClient.CollectionApi	getIssues	GET /list/issue	List the issues for a website
A11ywatchClient.CollectionApi	getPageSpeed	GET /list/pagespeed	Get the pagespeed for a website
A11ywatchClient.CollectionApi	getPages	GET /list/pages	List the pages in order for a website
A11ywatchClient.CollectionApi	getWebsites	GET /list/website	Returns websites for the user in alphabetical order
A11ywatchClient.ReportsApi	crawlWebsiteStream	POST /crawl	Multi-page crawl a website streaming issues on found
A11ywatchClient.ReportsApi	crawlWebsitesSync	POST /websites-sync	Multi-page crawl all websites attached to account
A11ywatchClient.ReportsApi	getReport	GET /report	Get the report from a previus scan
A11ywatchClient.ReportsApi	scanWebsite	POST /scan	Scan a website for issues
A11ywatchClient.ReportsApi	scanWebsiteSimple	POST /scan-simple	Scan a website for issues without storing data and limited responses.
A11ywatchClient.UserApi	createUser	POST /register	Register user into the system
A11ywatchClient.UserApi	getUsers	GET /user	Get user
A11ywatchClient.UserApi	loginUser	POST /login	Logs user into the system
A11ywatchClient.UserApi	logoutUser	POST /logout	Logs out current logged in user session
A11ywatchClient.WebsitesApi	addWebsite	POST /website	Add a website in the collection with form data
A11ywatchClient.WebsitesApi	deleteWebsite	DELETE /website	Deletes a website
A11ywatchClient.WebsitesApi	getWebsiteByDomain	GET /website	Find website by Domain

Documentation for Models

• A11ywatchClient.Analytics
• A11ywatchClient.AuthInput
• A11ywatchClient.CrawlInput
• A11ywatchClient.GenericInput
• A11ywatchClient.History
• A11ywatchClient.Issues
• A11ywatchClient.IssuesInfo
• A11ywatchClient.PageIssue
• A11ywatchClient.PageLoadTime
• A11ywatchClient.Pages
• A11ywatchClient.Report
• A11ywatchClient.Users
• A11ywatchClient.WebsiteInput
• A11ywatchClient.Websites
• A11ywatchClient.WebsitesInsight

Documentation for Authorization

bearerAuth

• Type: Bearer authentication (JWT)