screenshotone/sdk

A PHP SDK for the ScreenshotOne.com API to take screenshots of any URL

v1.0.4 2024-04-01 08:20 UTC

Requires

• guzzlehttp/guzzle: ^7.0

Requires (Dev)

• phpunit/phpunit: ^9

MIT

• Dmytro Krasun

README

An official Screenshot API client for PHP.

It takes minutes to start taking screenshots. Just sign up to get access and secret keys, import the client, and you are ready to go.

The SDK client is synchronized with the latest screenshot API options.

Installation

composer require screenshotone/sdk:^1.0

Usage

Generate a screenshot URL without executing the request. Or download the screenshot. It is up to you:

<?php 

// If you don't use Composer in your project, please, read https://getcomposer.org/doc/01-basic-usage.md#autoloading. 
// You need the Composer autoloader to use the API SDK.

// ...

use ScreenshotOne\Sdk\Client;
use ScreenshotOne\Sdk\TakeOptions;

$client = new Client('M73PaLOC8lchKQ', 'VjuscNqAfGCC4A');

$options = TakeOptions::url("https://example.com")
    ->fullPage(true)
    ->delay(2)
    ->geolocationLatitude(48.857648)
    ->geolocationLongitude(2.294677)
    ->geolocationAccuracy(50);

$url = $client->generateTakeUrl($options);
echo $url.PHP_EOL;
// expected output: https://api.screenshotone.com/take?url=https%3A%2F%2Fexample.com...

$image = $client->take($options);
file_put_contents('example.png', $image);

Tests

Run:

$ composer run-script tests

Or:

$ vendor/bin/phpunit

License

screenshotone/phpsdk is released under the MIT license.