Who can use this feature?
- Organization administrators, workspace administrators, and workspace users.
- Available for Accelerate and Enterprise.
Scan internal environments or intranets using the Desktop Crawler App. To scan with Desktop Crawler App, make sure you've downloaded and installed the application first.
The Desktop Crawler App can scan up to 100 pages with a crawl depth of 25.
On this page:
- Log in to the environment
- Generate an API key
- Log in to the Desktop Crawler App
- Scan with the Desktop Crawler App
Log in to the environment
The Desktop Crawler App requires your access to the environment you want to scan. This means you have to log in to the environment you want to scan before logging in to the Desktop Crawler App.
Before logging into the Desktop Crawler App:
- Log in to the environment you want to scan. Note that the browser you use must correspond with the browser you select in Scan with the Desktop Crawler App step 4.a.
Generate an API key
Each time you log in to the Desktop Crawler App, you need an API key. We recommend saving the API key somewhere like a password manager or downloading the .txt file, so you don't have to generate a new one each time you use the app.
Note:
- API keys are only valid for six months.
- API keys are user-specific.
- You can only access this API key from the platform at the time of generation. Be sure to save it immediately, as it won't be available in the platform later.
To generate an API key:
- From the Control hub, go to Tools and Integrations.
- Choose the API tab.
- Enter a name for the key and select Generate new API key.
- Copy or download the key.
Log in to the Desktop Crawler App
Once you've installed the Desktop Crawler App, you can log in to the app with your organization URL and API key.
To log in to the Desktop Crawler App:
- Open the app.
- Enter your organization URL. For example, https://ACME.hub.essentia11y.com/.
- Enter your API key.
You're ready to start scanning.
Scan with the Desktop Crawler App
Note:
- If you're using Chrome to scan with the Desktop Crawler App, you must close any Chrome windows before scanning. Alternatively, you can use a different browser without this limitation.
- The Desktop Crawler App is:
- Available for Chrome, Edge, and Firefox.
- Not available for Safari.
To scan with the Desktop Crawler App:
- Select the workspace with website you want to scan.
- Find the website you want to scan and select Create scan.
- Enter or select the:
- Browser. If you're on Windows and the default browser is supported, it will be selected automatically.
- Scan title.
- Website URL.
- Scan tag.
- Maximum number of pages.
- Crawl depth.
- Skip URL:
- # endings
- ? endings
- Select Run scan.
Once the scan is complete, you can view the results in the platform or run a new scan.
Comments
0 comments
Article is closed for comments.