ScreenshotCenter 1.0.2

ScreenshotCenter .NET SDK

Official C# / .NET SDK for the ScreenshotCenter API.

Requirements

• .NET 6.0 or later

Installation

dotnet add package ScreenshotCenter

Quick start

using ScreenshotCenter;

var client = new ScreenshotCenterClient(Environment.GetEnvironmentVariable("SCREENSHOTCENTER_API_KEY")!);

var shot   = await client.Screenshot.CreateAsync("https://example.com");
var result = await client.WaitForAsync(shot.Id);
Console.WriteLine(result.Status); // "finished"

Use cases

Geo-targeting

var shot = await client.Screenshot.CreateAsync("https://example.com",
    new Dictionary<string, string> { ["country"] = "fr", ["lang"] = "fr-FR" });

PDF

var shot = await client.Screenshot.CreateAsync("https://example.com",
    new Dictionary<string, string> { ["pdf"] = "true" });
var done = await client.WaitForAsync(shot.Id);
await client.Screenshot.SavePdfAsync(done.Id, "/tmp/page.pdf");

Multiple shots

var shot = await client.Screenshot.CreateAsync("https://example.com",
    new Dictionary<string, string> { ["shots"] = "5" });
var done = await client.WaitForAsync(shot.Id);
await client.Screenshot.SaveImageAsync(done.Id, "/tmp/shot3.png",
    new Dictionary<string, string> { ["shot"] = "3" });

Batch

// Requires batch worker service to be running
var batch  = await client.Batch.CreateAsync(
    new[] { "https://example.com", "https://example.org" }, "us");
var result = await client.Batch.WaitForAsync(batch.Id, intervalMs: 3000, timeoutMs: 120_000);
await client.Batch.SaveZipAsync(result.Id, "/tmp/batch.zip");

Error handling

try
{
    var result = await client.WaitForAsync(shot.Id, timeoutMs: 60_000);
}
catch (ScreenshotFailedException e)
{
    Console.Error.WriteLine($"Failed: {e.Reason}");
}
catch (TimeoutException e)
{
    Console.Error.WriteLine($"Timed out after {e.TimeoutMs}ms");
}
catch (ApiException e)
{
    Console.Error.WriteLine($"API error {e.Status}: {e.Message}");
}

API reference

ScreenshotCenterClient(apiKey, baseUrl?, httpClient?)

client.Screenshot

client.Batch

client.Account

client.WaitForAsync(id, intervalMs?, timeoutMs?)

Poll a screenshot until finished or error.

Testing

Environment variables

Running tests

# Unit tests only (default)
dotnet test

# Integration tests against a local instance
SCREENSHOTCENTER_API_KEY=your_key \
SCREENSHOTCENTER_BASE_URL=http://localhost:3000/api/v1 \
dotnet test --filter "Category=Integration"

License

MIT — see LICENSE.