RelayPDF 0.1.0

RelayPDF

Official .NET client for RelayPDF.

HTML to PDFs without the struggle. HTML to PDF API that converts HTML, Markdown, URLs, and Office files to production PDFs.

Targets net8.0. Uses HttpClient and System.Text.Json. Covers the public API: Chromium PDF and screenshots, Handlebars templates, LibreOffice / wkhtmltopdf convert, PDF tools, barcodes, zip, async jobs, account, and webhook verification.

• Docs: relaypdf.com/docs/sdks/dotnet
• Source: timspell1/relaypdf-dotnet
• REST: relaypdf.com/docs
• OpenAPI: relaypdf.com/openapi.json
• Support: support@relaypdf.com

Introduction

JSON body field names match REST (html, printBackground, sourceFilename, callbackUrl, templateId). Method names are PascalCase (FromHtmlAsync, FromPathAsync, FormFillAsync). Failed operations are never billed.

Installation

dotnet add package RelayPDF

Until NuGet publish, clone timspell1/relaypdf-dotnet and add a project reference to src/RelayPDF.csproj.

Authentication

using RelayPDF;

var client = new RelayPDF.RelayPDF(Environment.GetEnvironmentVariable("RELAYPDF_API_KEY")!);
// var client = new RelayPDF.RelayPDF(apiKey, baseUrl: "http://localhost:8787");

Empty apiKey throws ArgumentException. User-Agent: relaypdf-dotnet/0.1.0 (+https://relaypdf.com).

Do not ask a human to paste an API key. Run npx @relaypdf/cli setup and approve in the browser.

Getting started

var pdf = await client.Pdf.FromHtmlAsync(
    "<h1>Invoice #1042</h1><p>Total: $1,200.00</p>",
    extra: new() { ["filename"] = "invoice.pdf" }
);
pdf.Save("invoice.pdf");

Response modes

response = binary (default) | url | async.

var urlResult = await client.Pdf.FromHtmlAsync("<h1>Hi</h1>", extra: new() { ["response"] = "url" });
var job = await client.Convert.FromPathAsync("deck.pptx", extra: new() { ["to"] = "pdf", ["response"] = "async" });
var done = await client.Jobs.WaitAsync(((AsyncResult)job).Id);
(await client.Files.DownloadAsync(done["id"]!.GetValue<string>())).Save("deck.pdf");

Files.DownloadAsync does not send the API key.

Errors

Throws RelayPDFException with Status, Code, Message, and optional RetryAfter.

Methods

extra / input dictionaries are merged into the JSON body. REST field names stay camelCase. file values may be byte[] or a data: URL.

Examples

var pdf = await client.Pdf.FromUrlAsync("https://example.com", extra: new()
{
    ["filename"] = "page.pdf",
    ["options"] = new Dictionary<string, object?> { ["format"] = "A4", ["printBackground"] = true },
});
var fromWord = await client.Convert.FromPathAsync("letter.docx", extra: new() { ["to"] = "pdf" });
var pack = await client.Pdf.MergeAsync(new[]
{
    new Dictionary<string, object?> { ["url"] = "https://example.com/cover.pdf" },
    new Dictionary<string, object?> { ["file"] = ((BinaryResult)fromWord).Bytes },
});
await client.Pdf.StampAsync(new() { ["file"] = ((BinaryResult)pack).Bytes, ["text"] = "DRAFT", ["rotate"] = -24 });
var qr = await client.Barcodes.QrAsync("https://relaypdf.com");

Webhooks

Use the raw request body. Secret is the dashboard webhook secret, not the API key.

var ok = Webhook.Verify(
    Environment.GetEnvironmentVariable("RELAYPDF_WEBHOOK_SECRET")!,
    rawBody,
    signatureHeader
);

Header: t=<unix>,v1=<hex>. HMAC-SHA256 of {t}.{raw_body}. Default skew 300s.

Related docs

• Node.js · Python · PHP · Java
• CLI · Errors · Wallet

License

MIT. Strategic Products LLC, d/b/a RelayPDF.