ScreenshotPro Documentation

Introduction

ScreenshotPro is a powerful API service for capturing high-quality screenshots of web pages. Whether you need screenshots for monitoring, testing, or content generation, our API provides a reliable and scalable solution.

This documentation will help you get started with ScreenshotPro, providing detailed information about installation, configuration, and usage. Our goal is to make it as easy as possible for you to integrate screenshot capabilities into your applications.

Installation

You can use ScreenshotPro directly through our REST API, or integrate it into your application using one of our client libraries.

Client Libraries

Configuration

After signing up for ScreenshotPro, you'll receive an API key that you'll use to authenticate your requests. Make sure to keep your API key secure and never expose it in client-side code.

PHP Example

// Initialize the ScreenshotPro client
$client = new ScreenshotPro\Client('your_api_key');

// Configure default options
$client->setDefaultOptions([
    'format' => 'png',
    'resolution' => '1920x1080',
    'fullPage' => true
]);

JavaScript Example

// Initialize the ScreenshotPro client
const screenshotpro = new ScreenshotPro('your_api_key');

// Configure default options
screenshotpro.setDefaults({
    format: 'png',
    resolution: '1920x1080',
    fullPage: true
});

Authentication

All requests to the ScreenshotPro API must be authenticated using your API key. You can pass your API key in the request headers.

curl -X POST https://api.screenshotpro.com/api/screenshot \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com"
  }'

Rate Limits

Rate limits vary based on your account tier. If you exceed your rate limit, you'll receive a 429 Too Many Requests response.

All rate limits are reset at midnight UTC.

Error Handling

ScreenshotPro uses standard HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information, and codes in the 5xx range indicate an error with our servers.

Webhooks

ScreenshotPro can notify your application when a screenshot is ready through webhooks. This is especially useful for applications that need to be notified asynchronously when a screenshot has been captured.

Setting Up Webhooks

You can set up a webhook URL in your account settings, or you can specify a webhook URL for each screenshot request.

curl -X POST https://api.screenshotpro.com/api/screenshot \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "webhook_url": "https://your-app.com/webhook"
  }'

Webhook Payload

When a screenshot is ready, we'll send a POST request to your webhook URL with the following payload:

{
  "event": "screenshot.completed",
  "screenshot_id": "abc123",
  "url": "https://example.com",
  "format": "png",
  "resolution": "1280x720",
  "status": "completed",
  "created_at": "2025-03-28T12:34:56Z",
  "screenshot_url": "https://cdn.screenshotpro.com/screenshots/abc123.png"
}

Frequently Asked Questions