The font detection API for developers

1
// add com.screenshotone.jsdk:screenshotone-api-jsdk:[1.0.0,2.0.0)
2
// to your `pom.xml` or `build.gradle`
3

4
import com.screenshotone.jsdk.Client;
5
import com.screenshotone.jsdk.TakeOptions;
6

7
import java.io.File;
8
import java.nio.file.Files;
9

10
public class App {
11
    public static void main(String[] args) throws Exception {
12
        final Client client = Client.withKeys("<access key>", "<secret key>");
13
        TakeOptions takeOptions = TakeOptions.url("https://example.com")
14
                .fullPage(true)
15
                .deviceScaleFactor(1)
16
                .viewportHeight(1200)
17
                .viewportWidth(1200)
18
                .format("png")
19
                .omitBackground(true);
20
        final String url = client.generateTakeUrl(takeOptions);
21

22
        System.out.println(url);
23
        // Output: https://api.screenshotone.com/take?url=...
24

25
        // or download the screenshot
26
        final byte[] image = client.take(takeOptions);
27

28
        Files.write(new File("./example.png").toPath(), image);
29
        // the screenshot is stored in the example.png file
30
    }
31
}

1
// go get github.com/screenshotone/gosdk
2

3
import screenshots "github.com/screenshotone/gosdk"
4

5
client, err := screenshots.NewClient("<access key>", "<secret key>")
6
// check err
7

8
options := screenshots.NewTakeOptions("https://example.com").
9
    Format("png").
10
    FullPage(true).
11
    DeviceScaleFactor(2).
12
    BlockAds(true).
13
    BlockTrackers(true)
14

15
u, err := client.GenerateTakeURL(options)
16
// check err
17

18
fmt.Println(u.String())
19
// Output: https://api.screenshotone.com/take?url=...
20

21
// or download the screenshot
22
image, err := client.Take(context.TODO(), options)
23
// check err
24

25
defer image.Close()
26
out, err := os.Create("example.png")
27
// check err
28

29
defer out.Close()
30
io.Copy(out, image)
31
// the screenshot is stored in the example.png file

1
// $ npm install screenshotone-api-sdk --save
2

3
import * as fs from 'fs';
4
import * as screenshotone from 'screenshotone-api-sdk';
5

6
// create API client
7
const client = new screenshotone.Client("<access key>", "<secret key>");
8

9
// set up options
10
const options = screenshotone.TakeOptions
11
    .url("https://example.com")
12
    .delay(3)
13
    .blockAds(true);
14

15
// generate URL
16
const url = client.generateTakeURL(options);
17
console.log(url);
18
// expected output: https://api.screenshotone.com/take?url=...
19

20
// or download the screenshot
21
const imageBlob = await client.take(options);
22
const buffer = Buffer.from(await imageBlob.arrayBuffer());
23
fs.writeFileSync("example.png", buffer)
24
// the screenshot is stored in the example.png file

1
<?php
2

3
// composer require screenshotone/sdk:^1.0
4

5
use ScreenshotOneSdkClient;
6
use ScreenshotOneSdkTakeOptions;
7

8
$client = new Client("<access key>", "<secret key>");
9

10
$options = TakeOptions::url("https://example.com")
11
    ->fullPage(true)
12
    ->delay(2)
13
    ->geolocationLatitude(48.857648)
14
    ->geolocationLongitude(2.294677)
15
    ->geolocationAccuracy(50);
16

17
$url = $client->generateTakeUrl($options);
18
echo $url.PHP_EOL;
19
// expected output: https://api.screenshotone.com/take?url=https%3A%2F%2Fexample.com...
20

21
$image = $client->take($options);
22
file_put_contents('example.png', $image);
23
// the screenshot is stored in the example.png file

1
# pip install screenshotone
2

3
import shutil
4
from screenshotone import Client, TakeOptions
5

6
# create API client
7
client = Client('<access key>', '<secret key>')
8

9
# set up options
10
options = (TakeOptions.url('https://screenshotone.com')
11
    .format("png")
12
    .viewport_width(1024)
13
    .viewport_height(768)
14
    .block_cookie_banners(True)
15
    .block_chats(True))
16

17
# generate the screenshot URL and share it with a user
18
url = client.generate_take_url(options)
19
# expected output: https://api.screenshotone.com/take?url=https%3A%2F%2Fscreenshotone.com&viewport_width=1024&viewport_height=768&block_cookie_banners=True&block_chats=True&access_key=&signature=6afc9417a523788580fa01a9f668ea82c78a9d2b41441d2a696010bf2743170f
20

21
# or render a screenshot and download the image as stream
22
image = client.take(options)
23

24
# store the screenshot the example.png file
25
with open('example.png', 'wb') as result_file:
26
    shutil.copyfileobj(image, result_file)

1
# Add this gem to your Gemfile:
2
# gem 'screenshotone'
3

4
# If you don't need to add a signature
5
client = ScreenshotOne::Client.new('<access key>')
6

7
# Or ff you do need to add a signature
8
client = ScreenshotOne::Client.new('<access key>', '<secret key>')
9

10
# You can set any available option, in a camel_case format, for example:
11
options = ScreenshotOne::TakeOptions.new(url: 'https://example.com').
12
            full_page(true).
13
            delay(2).
14
            geolocation_latitude(48.857648).
15
            geolocation_longitude(2.294677).
16
            geolocation_accuracy(50)
17

18
# Verify all the parameters are valid (we will validate the parameters that should be
19
# numeric, booleans or that accept only certain values)
20
options.valid?
21
=> true
22

23
# To simply get the final url:
24
client.generate_take_url(options)
25
=> "https://api.screenshotone.com/take?url=https%3A%2F%2Fexample.com..."
26

27
# To actually get the image (the response body of a request to the previous url)
28
client.take(options)
29
=> "\xFF\xD8\xFF\xE0\x00\x10JFIF\x00\x01\x01\x00\x00\x01\x00\x01\x00\x00\xFF\..."

1
// Add the library via nuget using the package manager console: PM> Install-Package ScreenshotOne.dotnetsdk
2
// Or from the .NET CLI as: dotnet add package ScreenshotOne.dotnetsdk
3

4
// And generate a screenshot URL without executing request:
5
var client = new Client("<access key>", "<secret key>");
6
var options = TakeOptions.Url("https://www.amazon.com")
7
  .FullPage(true)
8
  .Format(Format.PNG)
9
  .BlockCookieBanners(true);
10

11
var url = client.GenerateTakeUrl(options);
12
// url = https://api.screenshotone.com/take?url=https%3A%2F%2Fwww.amazon.com&full_page=true&format=png&block_cookie_banners=true&access_key=_OzqMIjpCw-ARQ&signature=8a08e62d13a5c3490fda0734b6707791d3decc9ab9ba41e8cc045288a39db502
13

14
// Or take a screenshot and save the image in the file:
15
var client = new Client("<access key>", "<secret key>");
16
var options = TakeOptions.Url("https://www.google.com")
17
  .FullPage(true)
18
  .Format(Format.PNG)
19
  .BlockCookieBanners(true);
20

21
var bytes = await client.Take(options);
22

23
File.WriteAllBytes(@"c:\temp\example.png", bytes);