screenshothis/php

v0.1.1 2025-06-12 20:19 UTC

Requires

• php: ^8.2
• brick/date-time: ^0.7.0
• brick/math: ^0.12.1
• galbar/jsonpath: ^3.0
• guzzlehttp/guzzle: ^7.0
• phpdocumentor/type-resolver: ^1.8
• speakeasy/serializer: ^4.0.3

Requires (Dev)

• laravel/pint: ^1.21.2
• phpstan/phpstan: ^2.1.0
• phpunit/phpunit: ^10
• roave/security-advisories: dev-latest

MIT

README

Developer-friendly & type-safe Php SDK specifically catered to leverage screenshothis/php API.

Summary

Screenshothis API: API designed to take screenshots of websites

Table of Contents

• screenshothis/php
  • SDK Installation
  • SDK Example Usage
  • Available Resources and Operations
  • Error Handling
  • Server Selection
• Development
  • Maturity
  • Contributions

SDK Installation

The SDK relies on Composer to manage its dependencies.

To install the SDK and add it as a dependency to an existing composer.json file:

composer require "screenshothis/php"

SDK Example Usage

Example

declare(strict_types=1);

require 'vendor/autoload.php';

use Screenshothis\Screenshothis;
use Screenshothis\Screenshothis\Models\Operations;

$sdk = Screenshothis\Screenshothis::builder()->build();

$request = new Operations\TakeScreenshotRequest(
    apiKey: 'sk_live_abcdef1234567890abcdef1234567890',
    url: 'https://example.com',
    selector: '.main-content',
    blockRequests: '*.doubleclick.net\n' .
    '*.googletagmanager.com\n' .
    '*/analytics/*',
    blockResources: [
        Operations\BlockResource::Script,
        Operations\BlockResource::Stylesheet,
        Operations\BlockResource::Font,
    ],
    cacheKey: 'homepage-desktop-light',
    headers: 'User-Agent: MyBot/1.0\n' .
    'Authorization: Bearer token123\n' .
    'X-Custom-Header: value',
    cookies: 'session_id=abc123; Domain=example.com; Path=/; Secure\n' .
    'user_pref=dark_mode; Max-Age=3600',
);

$response = $sdk->takeScreenshot(
    request: $request
);

if ($response->twoHundredImageJpegBytes !== null) {
    // handle response
}

Available Resources and Operations

Available methods

Screenshothis SDK

• takeScreenshot - Generate optimized website screenshot
• health - Comprehensive health check
• ready - Readiness probe
• live - Liveness probe

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an exception.

By default an API error will raise a Errors\APIException exception, which has the following properties:

Property	Type	Description
$message	string	The error message
$statusCode	int	The HTTP status code
$rawResponse	?\Psr\Http\Message\ResponseInterface	The raw HTTP response
$body	string	The response content

When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the takeScreenshot method throws the following exceptions:

Error Type	Status Code	Content Type
Errors\ForbiddenException	403	application/json
Errors\InternalServerError	500	application/json
Errors\APIException	4XX, 5XX	*/*

Example

declare(strict_types=1);

require 'vendor/autoload.php';

use Screenshothis\Screenshothis;
use Screenshothis\Screenshothis\Models\Errors;
use Screenshothis\Screenshothis\Models\Operations;

$sdk = Screenshothis\Screenshothis::builder()->build();

try {
    $request = new Operations\TakeScreenshotRequest(
        apiKey: 'sk_live_abcdef1234567890abcdef1234567890',
        url: 'https://example.com',
        selector: '.main-content',
        blockRequests: '*.doubleclick.net\n' .
        '*.googletagmanager.com\n' .
        '*/analytics/*',
        blockResources: [
            Operations\BlockResource::Script,
            Operations\BlockResource::Stylesheet,
            Operations\BlockResource::Font,
        ],
        cacheKey: 'homepage-desktop-light',
        headers: 'User-Agent: MyBot/1.0\n' .
        'Authorization: Bearer token123\n' .
        'X-Custom-Header: value',
        cookies: 'session_id=abc123; Domain=example.com; Path=/; Secure\n' .
        'user_pref=dark_mode; Max-Age=3600',
    );

    $response = $sdk->takeScreenshot(
        request: $request
    );

    if ($response->twoHundredImageJpegBytes !== null) {
        // handle response
    }
} catch (Errors\ForbiddenExceptionThrowable $e) {
    // handle $e->$container data
    throw $e;
} catch (Errors\InternalServerErrorThrowable $e) {
    // handle $e->$container data
    throw $e;
} catch (Errors\APIException $e) {
    // handle default exception
    throw $e;
}

Server Selection

Override Server URL Per-Client

The default server can be overridden globally using the setServerUrl(string $serverUrl) builder method when initializing the SDK client instance. For example:

declare(strict_types=1);

require 'vendor/autoload.php';

use Screenshothis\Screenshothis;
use Screenshothis\Screenshothis\Models\Operations;

$sdk = Screenshothis\Screenshothis::builder()
    ->setServerURL('https://api.screenshothis.com')
    ->build();

$request = new Operations\TakeScreenshotRequest(
    apiKey: 'sk_live_abcdef1234567890abcdef1234567890',
    url: 'https://example.com',
    selector: '.main-content',
    blockRequests: '*.doubleclick.net\n' .
    '*.googletagmanager.com\n' .
    '*/analytics/*',
    blockResources: [
        Operations\BlockResource::Script,
        Operations\BlockResource::Stylesheet,
        Operations\BlockResource::Font,
    ],
    cacheKey: 'homepage-desktop-light',
    headers: 'User-Agent: MyBot/1.0\n' .
    'Authorization: Bearer token123\n' .
    'X-Custom-Header: value',
    cookies: 'session_id=abc123; Domain=example.com; Path=/; Secure\n' .
    'user_pref=dark_mode; Max-Age=3600',
);

$response = $sdk->takeScreenshot(
    request: $request
);

if ($response->twoHundredImageJpegBytes !== null) {
    // handle response
}

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy