Screenshot API

LAST UPDATED: 07/03/2024

Overview

ScreenshotAPI is a simple API that allows you to take programmatic screenshots of any website with ease.

D3 SOAR is providing REST operations to function with Screenshot API.

Screenshot API is available for use in:

Connection

To connect to Screenshot API from D3 SOAR, please follow this part to collect the required information below:

Configuring Screenshot API to Work with D3 SOAR

1. For obtaining an existing API key, please refer to screenshotapi.net.

2. For issuing a fresh API key and revoking access from the previous key, click Roll API Key in the Settings card on the Dashboard.

Configuring D3 SOAR to Work with Screenshot API

1. Log in to D3 SOAR.

2. Find the Screenshot API integration.

   

   1. Navigate to Configuration on the top header menu.

   2. Click on the Integration icon on the left sidebar.

   3. Type Screenshot API in the search box to find the integration, then click it to select it.

   4. Click + Connection, on the right side of the Connections section. A new connection window will appear.

3. Configure the following fields to create a connection to Screenshot API.

   

   1. Connection Name: The desired name for the connection.

   2. Site: Specifies the site to use the integration connection. Use the drop-down menu to select the site. The Share to Internal Sites option enables all sites defined as internal sites to use the connection. Selecting a specific site will only enable that site to use the connection.

   3. Recipient site for events from connections Shared to Internal Sites: This field appears if you selected Share to Internal Sites for Site to let you select the internal site to deploy the integration connection.

   4. Agent Name (Optional): Specifies the proxy agent required to build the connection. Use the dropdown menu to select the proxy agent from a list of previously configured proxy agents.

   5. Description (Optional): Add your desired description for the connection.

   6. Tenant (Optional): When configuring the connection from a master tenant site, you have the option to choose the specific tenant sites you want to share the connection with. Once you enable this setting, you can filter and select the desired tenant sites from the dropdowns to share the connection.

      

   7. Configure User Permissions: Defines which users have access to the connection.

   8. Active: Check the tick box to ensure the connection is available for use.

      

   9. System: This section contains the parameters defined specifically for the integration. These parameters must be configured to create the integration connection.
      1. Input your domain level Server URL.
      2. Input your API Token.
      3. Input the API Version. The default value is v1.

   10. Enable Password Vault: An optional feature that allows users to take the stored credentials from their own password vault. Please refer to the password vault connection guide if needed.

   11. Connection Health Check: Updates the connection status you have created. A connection health check is done by scheduling the Test Connection command of this integration. This can only be done when the connection is active.
       To set up a connection health check, check the Connection Health Check tickbox. You can customize the interval (minutes) for scheduling the health check. An email notification can be set up after a specified number of failed connection attempts.

4. Test the connection.

   1. Click Test Connection to verify the account credentials and network connection. If the Test Connection Passed alert window appears, the test connection is successful. You will see Passed with a green checkmark appear beside the Test Connection button. If the test connection fails, please check your connection parameters and try again.

   2. Click OK to close the alert window.

   3. Click + Add to create and add the configured connection.

Commands

Screenshot API includes the following executable commands for users to set up schedules or create playbook workflows. With the Test Command, you can execute these commands independently for playbook troubleshooting.

Integration API Note

For more information about the Screenshot API API, please refer to the Screenshot API API reference.

Capture Webpage Screenshots

Serves as a utility for capturing screenshots of webpages. It can generate a screenshot of either the entire webpage or a specified portion, and retrieves it as either a binary data stream or an image link. Both outputs can be directly saved to a file in the D3 system.

Input

Output

Successful

{
    "Results": [
        {
            "url": "apple.com",
            "fileId": "*****",
            "fileName": "screenshot_apple.com_*****.png",
            "md5": "*****",
            "sha1": "*****",
            "sha256": "*****"
        },
        {
            "screenshot": "https://storage.screenshotapi.net/*****.png",
            "url": "https://www.apple.com/ca/store?afid=*****|*****-*****&cid=aos-ca-kwGO-brand--slid---product-",
            "created_at": "2024-04-24T18:01:39.808Z",
            "is_fresh": true,
            "token": "<TOKEN>",
            "fresh": "true",
            "output": "json",
            "full_page": "true",
            "ttl": "2024-05-24T18:01:31.729Z",
            "fileId": "*****",
            "fileName": "screenshot_www.apple.com%2Fca%*****.png",
            "md5": "*****",
            "sha1": "*****",
            "sha256": "*****"
        }
    ],
    "D3Errors": []
}

{
    "ScreenshotURLs":[
        "https://storage.screenshotapi.net/*****.png"
    ],
    "FileIDs": [
        "*****"
    ],
    "FileNames": [
        "screenshot_www.apple.com%2Fca%*****.png"
    ]
}

Error Handling

If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Test Connection

Allows you to perform a health check on an integration connection. You can schedule a periodic health check by selecting Connection Health Check when editing an integration connection.

Input

N/A

Output

Successful

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.