setApiKey method

Class: EyesPlatform: Selenium 4Language: JavaScript SDK:
Latest
other languages

Use this method to set your Eyes license key.

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

Syntax


eyes.setApiKey(apiKey);

Parameters

apiKey
Type:string
A string that is your API Key.

Return value

Type:

Remarks

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.