30 lines
1.8 KiB
Markdown
Executable File
30 lines
1.8 KiB
Markdown
Executable File
# Screenshot API Settings
|
|
|
|
**Dotjuice → Screenshot API**
|
|
|
|
This page configures the credentials the [Screenshot Capture](widgets/screenshot-capture.md) widget needs to function, and lets you manage the local cache of captured screenshots.
|
|
|
|
## Setting up your API key
|
|
|
|
1. Sign up for a Screenshot Machine account and get an API key (a link to their site is provided on the settings page).
|
|
2. Paste your **API Key** into the field and save. A warning banner at the top of the page will disappear once a key is saved.
|
|
3. If your Screenshot Machine account has a **Secret Key** configured for additional request security, enter it in the optional **Secret Key** field too — most accounts don't need this.
|
|
|
|
Until an API key is entered, every Screenshot Capture widget on your site will fail to display an image.
|
|
|
|
## Cache management
|
|
|
|
This section 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 the cache deletes every cached screenshot file and removes the corresponding entries from your Media Library. Every widget will re-capture its screenshot (spending a fresh API call) the next time its page is viewed. Use this if you've made site-wide changes to target pages and want everything refreshed at once, rather than refreshing screenshots one at a time from the editor.
|
|
|
|
## Things to know
|
|
|
|
- Every screenshot capture — whether from a visitor loading an uncached page, or your own manual refresh — counts as one billed API call against your Screenshot Machine plan. Keep this in mind if you have many Screenshot Capture widgets with a low or zero Cache Limit.
|
|
- The Secret Key field is optional and only relevant if you've specifically enabled request signing in your Screenshot Machine account settings.
|