Urlbox/Screenshots

Capture highly accurate webpage screenshots of any site using Urlbox.io in PHP

This package uses the Urlbox.io screenshot as a service to generate website screenshots.

Installation

This package can be installed through Composer.

composer require urlbox/screenshots

When using Laravel there is a service provider that you can make use of:

// app/config/app.php

'providers' => [
    '...',
    'Urlbox\Screenshots\UrlboxProvider'
];

setup your API keys:

// config/services.php

'urlbox' => [
    'key'    => env('URLBOX_KEY'),
    'secret' => env('URLBOX_SECRET')
];

and in your .env file:

# URLBOX
URLBOX_KEY=YOUR_URLBOX_KEY
URLBOX_SECRET=YOUR_URLBOX_SECRET

Usage

You will need a Urlbox account to use this package. Please signup here and get your API Key and Secret from the Urlbox dashboard once you have logged in.

Here is a sample call to generate a Urlbox screenshot URL:

    use Urlbox\Screenshots\Urlbox;
    $urlbox = Urlbox::fromCredentials('API_KEY', 'API_SECRET');
    // only required option is a url:
    $options['url'] = 'example.com';
    // specify any other options to augment the screenshot...
    $options['width'] = 1280;
    $options['height'] = 1024;
    // Create the Urlbox URL
    $urlboxUrl = $urlbox->generateUrl($options);
    // $urlboxUrl is now 'https://api.urlbox.io/v1/API_KEY/TOKEN/png?url=example.com'
    // Generate a screenshot by loading the Urlbox URL in an img tag:
    echo '<img src="'.$urlboxUrl.'" alt="Test screenshot generated by Urlbox">'

If you're using Laravel and have setup the service provider, you can use the Facade provided:

use Urlbox\Screenshots\Facades\Urlbox;

$options["url"] = "example.com";
$urlboxUrl = Urlbox::generateUrl($options);
// $urlboxUrl is now 'https://api.urlbox.io/v1/API_KEY/TOKEN/png?url=example.com'

You can now use the result ($urlboxUrl) by placing it inside an <img/> tag as the src parameter.

When you load the image, a screenshot of example.com will be returned.

The following options can be passed to the generateUrl method:

Other implementations

• Node.js

Contributing

We are open to pull requests.

Security

If you discover any security related issues, please email services@urlbox.io instead of using the issue tracker.

About Urlbox

Urlbox is a premium Screenshot as a Service API. It lets you render highly accurate screenshots of webpages and display them anywhere you like. Urlbox.io.

License

The MIT License (MIT).