Applitools Eyes integration

Learn how to integrate Applitools Eyes with Kobiton, allowing you to view the Eyes status and access the detailed Eyes report from Session Overview.

Before you start

  • An Applitools Eyes account is required.

  • Obtain the username and API key of a Kobiton account with the predefined role ADMIN.

  • Available for Kobiton Cloud, Hybrid, and Standalone customers with Internet access.

  • For Standalone customers, set up a custom domain for the Kobiton portal that ends with kobiton.com on the script runner machine. Example: example.kobiton.com, lab1.kobiton.com.

  • This feature has been tested with Applitools Public Cloud. Applitools Private Cloud or On-premises customers may require additional networking changes to complete the integration. Contact Kobiton support for assistance in these instances.

Create Applitools API key

Log into Applitools Eyes with an admin account.

Select the User icon, then choose Admin.

Selecting the User icon and then choosing the Admin option

In the admin panel, choose API keys.

In the Admin panel, choosing the API keys option

If you do not have an API key with read permission, select the Add a new API key icon.

In case of not having the API key with read permissoin, selecting the Add a new API key option

If you create a new API key, select the team and user, then turn on the read permission.

In the case of creating a new API key, selecting the team and user option and then turning on the read permissions.

Contact Applitools if you cannot enable the read permission.

Select Add to create the key. After creating the key, hover over it to copy to clipboard. You’ll need it to complete the integration in the Kobiton Portal.

Secting Add option to create the API key and copying the key to clipboard.

Enable integration

Log in to Kobiton as a user with the predefined role ADMIN.

Select your profile picture, then choose Settings.

Select the Integration tab, then choose Connect account under Visual Validation/Applitools Integration.

In kobiton, selectin the Integration tab and choosing the Connect account option under Visial Validation/Applitools Integration

Input the Applitools API Key copied earlier. If you use a custom URL for your Applitools server, replace the Applitools Server URL field with the correct value.

Entering the API key copied in the earlier steps

Select Connect. If the connection is successful, a confirmation message will appear.

Success message displayed after clicking the Connect button in the previous step.

The Applitools Eyes integration is now enabled. Proceed to run your Appium script with the Eyes SDK on Kobiton devices.