Skip to content

Authentication

Each API call made against https://api.appelium.com needs to be authorized. Appelium supports header based authorization using security tokens.

Each client must send a valid API token in the X-Appelium-Token header when making requests to protected resources.

Acquiring an Appelium API Key

  1. To start using the REST APIs, it is necessary to create an API Token. You can do this by navigating to API Access Settings page in Dashboard.
  2. Click on New API Key
  3. Copy and store it in a secure location for later use.

Tip

For security reasons, you will not be able to view the token again in Dashboard after you click the Close button. So make sure you have stored it safely.

Each account can create as many API Keys as needed, so feel free to organize them based on platform or however you find suitable.

Example

If your API Key is api-mg63nokcdbfiaf7zgtheofk0168hextn then you can send it in X-Appelium-Token header like this:

X-Appelium-Token: api-mg63nokcdbfiaf7zgtheofk0168hextn