shotapi/shotapi-php

Official PHP SDK for ShotAPI - Screenshot & Rendering API

Maintainers

Package info

github.com/dasigor/shotapi-php

Homepage

pkg:composer/shotapi/shotapi-php

Statistics

Installs: 0

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

Security

Advisories: 0

Aikido package health analysis

1.0.0 2026-02-06 10:34 UTC

Requires

MIT 1b5fcf5e08daf137773da291dc277e841bfe235e

  • ShotAPI <support.woop@shotapi.net>

imageapiwebpdfhtmlrenderscreenshotcapture

This package is auto-updated.

Last update: 2026-03-06 11:03:17 UTC

README

Official PHP SDK for ShotAPI - The Screenshot & Rendering API.

Requirements

  • PHP 7.4 or higher
  • cURL extension
  • JSON extension

Installation

composer require shotapi/shotapi-php

Or add to your composer.json:

{
    "require": {
        "shotapi/shotapi-php": "^1.0"
    }
}

Quick Start

<?php
require 'vendor/autoload.php';

use ShotAPI\Client;

$client = new Client('sk_your_api_key');

// Take a screenshot
$image = $client->screenshot('https://example.com');
file_put_contents('screenshot.png', $image);

Usage Examples

Basic Screenshot

$client = new Client('sk_your_api_key');

// Simple screenshot
$image = $client->screenshot('https://stripe.com');

// Full-page screenshot with options
$image = $client->screenshot('https://github.com', [
    'fullPage' => true,
    'format' => 'png',
    'width' => 1920,
    'height' => 1080,
]);

// Dark mode with retina
$image = $client->screenshot('https://example.com', [
    'darkMode' => true,
    'deviceScaleFactor' => 2,
    'blockAds' => true,
]);

Device Mockups

// iPhone mockup
$image = $client->screenshot('https://example.com', [
    'mockup' => 'iphone',
]);

// MacBook mockup
$image = $client->screenshot('https://example.com', [
    'mockup' => 'macbook',
]);

HTML to Image

$html = <<<HTML
<div style="padding: 40px; background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);">
    <h1 style="color: white; font-family: sans-serif;">Hello World!</h1>
</div>
HTML;

$image = $client->render($html, [
    'width' => 800,
    'height' => 400,
]);

Metadata Extraction

// Get page metadata
$meta = $client->metadata('https://github.com');
echo $meta['title'];
echo $meta['description'];
echo $meta['og_image'];

// With markdown content
$meta = $client->metadata('https://example.com', [
    'extractMarkdown' => true,
]);
echo $meta['markdown'];

Batch Screenshots

$urls = [
    'https://google.com',
    'https://github.com',
    'https://stripe.com',
];

$result = $client->batch($urls, [
    'format' => 'png',
    'fullPage' => true,
]);

foreach ($result['results'] as $item) {
    echo "{$item['url']} -> {$item['filename']}\n";
}

Visual Diff

$result = $client->diff(
    'https://example.com',
    'https://example.org',
    ['width' => 1280, 'height' => 720]
);

echo "Pages differ by {$result['percentage']}%\n";
file_put_contents('diff.png', $result['image']);

Advanced Options

$image = $client->screenshot('https://example.com', [
    'width' => 1280,
    'height' => 720,
    'fullPage' => true,
    'format' => 'png',
    'delay' => 2,
    'darkMode' => true,
    'deviceScaleFactor' => 2,
    'customCss' => "body { font-family: 'Comic Sans MS' !important; }",
    'customJs' => "document.querySelector('.popup').remove()",
    'waitForSelector' => '.content-loaded',
    'clickSelector' => '.accept-cookies',
    'hideSelectors' => ['.ad-banner', '.newsletter-popup'],
    'blockAds' => true,
    'headers' => ['Authorization' => 'Bearer token'],
    'cookies' => [
        ['name' => 'session', 'value' => 'abc123', 'domain' => 'example.com'],
    ],
    'geolocation' => ['latitude' => 40.7128, 'longitude' => -74.0060],
    'timezone' => 'America/New_York',
]);

Error Handling

use ShotAPI\Client;
use ShotAPI\ShotAPIException;

$client = new Client('sk_your_api_key');

try {
    $image = $client->screenshot('https://example.com');
} catch (ShotAPIException $e) {
    if ($e->isAuthError()) {
        echo "Invalid API key\n";
    } elseif ($e->isRateLimited()) {
        echo "Rate limit exceeded\n";
    } elseif ($e->isFeatureNotAvailable()) {
        echo "Feature not available on your plan\n";
    } else {
        echo "API error: " . $e->getMessage() . "\n";
    }
}

Configuration

// Custom base URL and timeout
$client = new Client(
    'sk_your_api_key',
    'https://shotapi.net',  // base URL
    120                      // timeout in seconds
);

Laravel Integration

// config/services.php
'shotapi' => [
    'key' => env('SHOTAPI_KEY'),
],

// App\Providers\AppServiceProvider.php
public function register()
{
    $this->app->singleton(\ShotAPI\Client::class, function () {
        return new \ShotAPI\Client(config('services.shotapi.key'));
    });
}

// Usage in controller
public function screenshot(Request $request)
{
    $client = app(\ShotAPI\Client::class);
    $image = $client->screenshot($request->url);

    return response($image)->header('Content-Type', 'image/png');
}

Links

License

MIT License