screenshotmachine
v2.0.0
Published
Captures website screenshot and converts website to PDF using Screenshot machine - online website screenshot generator and website to PDF converter
Downloads
115
Maintainers
Readme
screenshotmachine-nodejs
Captures website screenshot and converts website to PDF using Screenshot machine - online website screenshot generator and website to PDF converter
Installation
Install Node.js package:
npm install screenshotmachine --save
First, you need to create a free/premium account at 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:
var customerKey = 'PUT_YOUR_CUSTOMER_KEY_HERE';
secretPhrase = ''; //leave secret phrase empty, if not needed
Website screenshot API
Set additional options to fulfill your needs:
options = {
//mandatory parameter
url : 'https://www.google.com',
// all next parameters are optional, see our website screenshot API doc for more details
dimension : '1366xfull', // or "1366xfull" for full length screenshot
device : 'desktop',
format: 'png',
cacheLimit: '0',
delay: '200',
zoom: '100'
}
More info about options can be found in our Website screenshot API.
Sample code
var screenshotmachine = require('screenshotmachine');
var customerKey = 'PUT_YOUR_CUSTOMER_KEY_HERE';
secretPhrase = ''; //leave secret phrase empty, if not needed
options = {
//mandatory parameter
url : 'https://www.google.com',
// all next parameters are optional, see our website screenshot API guide for more details
dimension : '1366xfull', // or "1366xfull" for full length screenshot
device : 'desktop',
format: 'png',
cacheLimit: '0',
delay: '200',
zoom: '100'
}
var apiUrl = screenshotmachine.generateScreenshotApiUrl(customerKey, secretPhrase, options);
//put link to your html code
console.log('<img src="' + apiUrl + '">');
Generated apiUrl
link can be placed in <img>
tag or used in your business logic later.
If you need to store captured screenshot as an image, just call:
var screenshotmachine = require('screenshotmachine');
var customerKey = 'PUT_YOUR_CUSTOMER_KEY_HERE';
secretPhrase = ''; //leave secret phrase empty, if not needed
options = {
//mandatory parameter
url : 'https://www.google.com',
// all next parameters are optional, see our website screenshot API guide for more details
dimension : '1366xfull', // or "1366xfull" for full length screenshot
device : 'desktop',
format: 'png',
cacheLimit: '0',
delay: '200',
zoom: '100'
}
var apiUrl = screenshotmachine.generateScreenshotApiUrl(customerKey, secretPhrase, options);
//save screenshot as an image
var fs = require('fs');
var output = 'output.png';
screenshotmachine.readScreenshot(apiUrl).pipe(fs.createWriteStream(output).on('close', function() {
console.log('Screenshot saved as ' + output);
}));
Captured screenshot will be saved as output.png
file in current directory.
Website to PDF API
Set the PDF options:
options = {
//mandatory parameter
url : 'https://www.google.com',
// all next parameters are optional, see our website to PDF API guide for more details
paper : 'letter',
orientation : 'portrait',
media: 'print',
bg: 'nobg',
delay: '2000',
scale: '50'
}
More info about options can be found in our Website to PDF API.
Sample code
var screenshotmachine = require('screenshotmachine');
var customerKey = 'PUT_YOUR_CUSTOMER_KEY_HERE';
secretPhrase = ''; //leave secret phrase empty, if not needed
options = {
//mandatory parameter
url : 'https://www.google.com',
// all next parameters are optional, see our website to PDF API guide for more details
paper : 'letter',
orientation : 'portrait',
media: 'print',
bg: 'nobg',
delay: '2000',
scale: '50'
}
var pdfApiUrl = screenshotmachine.generatePdfApiUrl(customerKey, secretPhrase, options);
//save PDF file
var fs = require('fs');
var output = 'output.pdf';
screenshotmachine.readScreenshot(pdfApiUrl).pipe(fs.createWriteStream(output).on('close', function() {
console.log('Pdf saved as ' + output);
}));
Captured PDF will be saved as output.pdf
file in the current directory.
License
The MIT License (MIT)