Files
dotjuice-plugin-docs/docs/dotjuice-elementor-tools/screenshot-api-settings.md
Johan f4838865c9 Docs pass: add widget screenshots and expand the user guides
Add 21 screenshots across the Elementor Tools docs and rework the pages
around them: clearer opening lines, settings tables that state defaults,
and callouts for the parts people trip over. Also refreshes the Pro
getting-started, Custom Product Tabs and Product Filter pages, plus the
matching marketing copy.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-07-31 06:13:57 +00:00

38 lines
2.4 KiB
Markdown
Executable File

# Screenshot API Settings
**Dotjuice → Integrations → Screenshot API**
This page holds the credentials the [Screenshot Capture](widgets/screenshot-capture.md) widget needs, and manages the local cache of captured screenshots.
![The Screenshot API tab on the Integrations page](./assets/img/screenshot-api-settings.png)
*Screenshot: the Integrations page with the Screenshot API tab active, showing the API Key and Secret Key fields and the Cache Management panel below.*
:::note Moved in the July 2026 release
This used to be a standalone **Screenshot API** item in the Dotjuice menu. It's now the first tab of **Integrations**, a shared home for widgets that talk to outside services. The settings themselves are unchanged.
:::
## Setting up your API key
1. Sign up for a Screenshot Machine account and get an API key — the settings page links to their site.
2. Paste the key into the **API Key** field and save. The warning banner at the top of the page disappears once a key is stored.
3. If your Screenshot Machine account has a **Secret Key** configured for request signing, enter it in the optional field too. Most accounts don't use this.
**Until an API key is saved, every Screenshot Capture widget on your site fails to display an image.** That's the single most common cause of a blank screenshot widget.
## Cache management
The panel shows:
- How many screenshots are currently cached
- Their total size on disk
- Where they're stored, inside your uploads folder
- A **Clear All Cached Screenshots** button
Clearing removes every cached file and its Media Library entry. Each widget then re-captures on the next page view, spending a fresh API call. Use it when you've changed many target pages at once and want everything refreshed — rather than refreshing screenshots individually from the editor.
## Things to know
- **Every capture is one billed API call** against your Screenshot Machine plan, whether triggered by a visitor loading an uncached page or by your own manual refresh. Worth watching if you run many Screenshot Capture widgets with a low or zero Cache Limit.
- **Clearing the cache is site-wide and immediate.** On a site with a lot of screenshots, the next visitor to each page absorbs the capture wait — consider warming them yourself afterwards.
- The Secret Key field is optional and only relevant if you've explicitly enabled request signing in your Screenshot Machine account.