Obtaining an axe DevTools Mobile API Key

Link to Obtaining an axe DevTools Mobile API Key copied to clipboard

This document describes how to obtain an API key to use with axe DevTools Mobile.

Background

Depending on how you test, you may need an API Key to use axe DevTools Mobile. Please note:

The API key is required when using:

  • Appium
  • Mobile Analyzer for iOS

You can use an API Key or Username/Password for:

  • Mobile SDKs
  • Mobile Analyzer for Android

Steps for Obtaining an API Key

In order to get an API key for axe DevTools Mobile, you need to have an active free trial or license. Once you have access, visit API Keys to add a new key. After you log in, you will see a screen similar to this:

A settings page for an axe Account with the option to Manage API Keys

Click on the ADD NEW API KEY button, and you will see a popup window like the one pictured below:

screenshot of ADD NEW API KEY modal, that shows the Product as “axe Mobile”

  1. You must select axe DevTools Mobile under Product.
  2. Give the key a Name.
  3. Finally click on Save.

After a few seconds, the updated Manage API Keys page will be displayed, as shown below. You'll see a message that the API Key was successfully added.

Success message showing that the user has added the API key. An arrow is pointing to a 'Copy' button.

Click on the button indicated by the arrow to copy your new API key to the clipboard. You'll see a message indicating that the API key was successfully copied.

Next Steps

You can now use your API key to access axe DevTools Mobile.

Is this page helpful?

Help us improve this page

Still need help?