Registering an account
To run visual tests and view results in the Applitools Eyes dashboard, you will need an Applitools account. If you do not already have an account, register a new account for free using either a GitHub account or a work email address.
Retrieving your API key
Every Applitools account has a secret API key. Visual tests require your API key to upload results to the Applitools cloud and connect the results to your account.
To find your Applitools API key:
- Log into the Applitools Eyes Dashboard or into your dedicated cloud.
- Click on the User icon at the top right of the window.
- Choose "My API key" from the dropdown menu.
Your key will be displayed in a modal. You will need to set your API key when you configure Applitools Eyes in your test suite. The quickstart guides provide specific configuration instructions for each Applitools SDK.
Do not share your Applitools API key publicly. Keep it secret and safe! Treat it like a password.