PHP code example of shotapi / shotapi-php
1. Go to this page and download the library: Download shotapi/shotapi-php library . Choose the download type require .
2. Extract the ZIP file and open the index.php.
3. Add this code to the index.php.
<?php
require_once('vendor/autoload.php');
/* Start to develop here. Best regards https://php-download.com/ */
shotapi / shotapi-php example snippets
ShotAPI\Client;
$client = new Client('sk_your_api_key');
// Take a screenshot
$image = $client->screenshot('https://example.com');
file_put_contents('screenshot.png', $image);
$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,
]);
// iPhone mockup
$image = $client->screenshot('https://example.com', [
'mockup' => 'iphone',
]);
// MacBook mockup
$image = $client->screenshot('https://example.com', [
'mockup' => 'macbook',
]);
$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,
]);
// 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'];
$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";
}
$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']);
$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',
]);
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";
}
}
// Custom base URL and timeout
$client = new Client(
'sk_your_api_key',
'https://shotapi.net', // base URL
120 // timeout in seconds
);
// 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');
}
bash
composer