PHP SDK

The PHP SDK provides a client for integrating PDFGate API endpoints into your PHP applications.

Source code: github.com/pdfgate/pdfgate-sdk-php
Package: packagist.org/packages/pdfgate/pdfgate-sdk-php

Requirements

PHP 7.4+

Installation

Install the package with Composer, then initialize the client with your API key.

1composer require pdfgate/pdfgate-sdk-php

Quick start

The example below generates a PDF from a URL and returns a pre-signed file URL.

1<?php23use PdfGate\PdfGateClient;45$client = new PdfGateClient('live_your_api_key');67$generated = $client->generatePdf([8    'url' => 'https://example.com',9    'pageSizeType' => 'a4',10    'preSignedUrlExpiresIn' => 120011]);1213echo $generated->getFileUrl();

Generate from HTML

You can also generate a PDF directly from raw HTML and attach metadata to the resulting document.

1$client->generatePdf([2    'html' => '<h1>Hello</h1>',3    'pageSizeType' => 'a4',4    'metadata' => ['source' => 'sdk'],5]);

Download a file

Use getFile to retrieve the output stream and save it locally.

1$stream = $client->getFile($documentId);2$output = fopen('output.pdf', 'wb');3stream_copy_to_stream($stream, $output);4fclose($output);5fclose($stream);

Core methods

Method	Purpose
`generatePdf`	Generate a PDF from HTML or a public URL.
`uploadFile`	Upload a PDF file for later transformations.
`getFile`	Download the PDF stream for a stored document.
`getDocument`	Retrieve document metadata and file URLs.
`flattenPdf`	Flatten interactive PDF fields into a static document.
`compressPdf`	Compress a PDF and return the resulting document record.
`protectPdf`	Encrypt a PDF and apply access restrictions.
`watermarkPdf`	Apply text or image watermarks to a document.
`extractPdfFormData`	Read form field values from a fillable PDF.
`createEnvelope`	Create a signing envelope from one or more documents.
`sendEnvelope`	Send an envelope to its recipients for signing.
`getEnvelope`	Retrieve the current status of an envelope.
`voidEnvelope`	Void an envelope so it can no longer be signed.
`deleteEnvelope`	Delete an envelope and remove its signed documents.
`createEmbedLink`	Create a short-lived signing link for an embedded recipient.
`createRecipient`	Store a recipient for reuse across envelopes.
`listRecipients`	List stored recipients by email.
`getRecipient`	Retrieve a stored recipient by ID.
`updateRecipient`	Update a stored recipient's name or metadata.