https://github.com/screenshotmachine/screenshotmachine-php
Simple example how to call screenshot machine's API using PHP.
https://github.com/screenshotmachine/screenshotmachine-php
fullpage-screenshot html-to-pdf html2pdf pdf-converter pdf-generator php-library render-service screenshot screenshot-generator screenshots thumbnail-generator thumbnails web-to-print webpage-capture webpage-screenshot webpage2pdf website-screenshot website-snapshot website-thumbnail website-to-pdf
Last synced: 5 months ago
JSON representation
Simple example how to call screenshot machine's API using PHP.
- Host: GitHub
- URL: https://github.com/screenshotmachine/screenshotmachine-php
- Owner: screenshotmachine
- License: mit
- Created: 2019-07-23T10:32:18.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-08-26T08:55:14.000Z (almost 7 years ago)
- Last Synced: 2025-10-06T02:29:26.657Z (8 months ago)
- Topics: fullpage-screenshot, html-to-pdf, html2pdf, pdf-converter, pdf-generator, php-library, render-service, screenshot, screenshot-generator, screenshots, thumbnail-generator, thumbnails, web-to-print, webpage-capture, webpage-screenshot, webpage2pdf, website-screenshot, website-snapshot, website-thumbnail, website-to-pdf
- Language: PHP
- Homepage: https://www.screenshotmachine.com
- Size: 7.81 KB
- Stars: 4
- Watchers: 0
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# screenshotmachine-php
Captures website screenshot and converts website to PDF using Screenshot machine - online website screenshot generator and website to PDF converter.
## Installation
a) using Composer - package manager for PHP
```php
php composer.phar require screenshotmachine/screenshotmachine-php
```
b) or download source code directly from GitHub.com
First, you need to create a free/premium account at [www.screenshotmachine.com](https://www.screenshotmachine.com) website. After registration, you will see your customer key in your user profile. Also secret phrase is maintained here. Please, use secret phrase always, when your API calls are called from publicly available websites.
Set-up your customer key and secret phrase (if needed) in the script:
```php
$customer_key = "PUT_YOUR_CUSTOMER_KEY_HERE";
$secret_phrase = ""; //leave secret phrase empty, if not needed
```
## Website screenshot API
Set additional options to fulfill your needs:
```php
//mandatory parameter
$options['url'] = "https://www.google.com";
// all next parameters are optional, see our website screenshot API guide for more details
$options['dimension'] = "1366x768"; // or "1366xfull" for full length screenshot
$options['device'] = "desktop";
$options['format'] = "png";
$options['cacheLimit'] = "0";
$options['delay'] = "200";
$options['zoom'] = "100";
```
More info about options can be found in our [Website screenshot API](https://www.screenshotmachine.com/website-screenshot-api.php).
#### Sample code
```php
generate_screenshot_api_url($options);
//put link to your html code
echo '
' . PHP_EOL;
```
Generated ```api_url``` link can be placed in ```![]()
``` tag or used in your business logic later.
If you need to store captured screenshot as an image, just call:
```php
generate_screenshot_api_url($options);
//save screenshot as an image
$output_file = 'output.png';
file_put_contents($output_file, file_get_contents($api_url));
echo 'Screenshot saved as ' . $output_file . PHP_EOL;
```
Captured screenshot will be saved as ```output.png``` file in current directory.
## Website to PDF API
Set the PDF options:
```php
//mandatory parameter
$options['url'] = "https://www.google.com";
// all next parameters are optional, see our website to PDF API guide for more details
$options['paper'] = "letter";
$options['orientation'] = "portrait";
$options['media'] = "print";
$options['bg'] = "nobg";
$options['delay'] = "2000";
$options['scale'] = "50";
```
More info about options can be found in our [Website to PDF API](https://www.screenshotmachine.com/website-to-pdf-api.php).
#### Sample code
```php
$customer_key = "PUT_YOUR_CUSTOMER_KEY_HERE";
$secret_phrase = ""; //leave secret phrase empty, if not needed
$machine = new ScreenshotMachine($customer_key, $secret_phrase);
//mandatory parameter
$options['url'] = "https://www.google.com";
// all next parameters are optional, see our website to PDF API guide for more details
$options['paper'] = "letter";
$options['orientation'] = "portrait";
$options['media'] = "print";
$options['bg'] = "nobg";
$options['delay'] = "2000";
$options['scale'] = "50";
$pdf_api_url = $machine->generate_pdf_api_url($options);
//save PDF file
$output_file = 'output.pdf';
file_put_contents($output_file, file_get_contents($pdf_api_url));
echo 'PDF saved as ' . $output_file . PHP_EOL;
```
Captured PDF will be saved as ```output.pdf``` file in the current directory.
# License
The MIT License (MIT)