包简介

Official PHP SDK for ShotAPI - Screenshot & Rendering API

README 文档

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

shotapi/shotapi-php 适用场景与选型建议

shotapi/shotapi-php 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 0 次下载、GitHub Stars 达 0，最近一次更新时间为 2026 年 02 月 06 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「image」「api」「web」「pdf」「html」「render」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 shotapi/shotapi-php 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 shotapi/shotapi-php 我们能提供哪些服务？

定制开发 / 二次开发

基于 shotapi/shotapi-php 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 shotapi/shotapi-php 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

webignition/web-resource-model 3

Model of a web-based resource

slavkovrn/yii2-lightbox 1

Yii2 LightBox image galary widget uses Lightbox v2.10.0 by Lokesh Dhakar

slavkovrn/yii2-imagecarousel 5

The Yii2 extension uses jQuery jquery.carousel-1.1.min.js and makes image carousel from php array of structure defined.

theodorejb/phaster 6

A PSR-7 compatible library for making CRUD API endpoints

webignition/web-resource-retriever 2

Retrieve a WebResourceInterface instance over HTTP

slavkovrn/yii2-imagegalary 2

The Yii2 extension uses jQuery PrettyPhoto and OwlCarousel js and makes image galary from php array of structure defined.

shotapi/shotapi-php

包简介

关键字：