The information in this topic may be out of date. The current SDK reference guide has moved here.

setApiKey method

Class: ConfigurationPlatform: Selenium 3Language: Java SDK:

Use this method to set your Eyes license key.

To obtain your API key, see How to obtain your API key.


Configuration configval = config.setApiKey(apiKey);


A string that is your API Key.

Return value

Type: Configuration
The value returned is the object that called the method. This allows you to use a fluent style to call the setXXXX methods of the Configuration class.


Set this immediately after the Eyes object is created (before calling open). If you have an environment variable called APPLITOOLS_API_KEY that is set to the value of your API key, then you do not need to call this method, and Eyes will take the string from the environment value.