PDFGeneratorAPI\DocumentsApi

All URIs are relative to https://us1.pdfgeneratorapi.com/api/v4, except if the operation defines another base path.

Method	HTTP request	Description
deleteDocument()	DELETE /documents/{publicId}	Delete document
generateDocument()	POST /documents/generate	Generate document
generateDocumentAsynchronous()	POST /documents/generate/async	Generate document (async)
generateDocumentBatch()	POST /documents/generate/batch	Generate document (batch)
generateDocumentBatchAsynchronous()	POST /documents/generate/batch/async	Generate document (batch + async)
getDocument()	GET /documents/{publicId}	Get document
getDocuments()	GET /documents	Get documents

`deleteDocument()`

deleteDocument($public_id)

Delete document

Delete document from the Document Storage

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: JSONWebTokenAuth
$config = PDFGeneratorAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new PDFGeneratorAPI\Api\DocumentsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$public_id = bac8381bce1982e5f6957a0f52371336; // string | Resource public id

try {
    $apiInstance->deleteDocument($public_id);
} catch (Exception $e) {
    echo 'Exception when calling DocumentsApi->deleteDocument: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
public_id	string	Resource public id

Return type

void (empty response body)

Authorization

JSONWebTokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`generateDocument()`

generateDocument($generate_document_request): \PDFGeneratorAPI\Model\AddWatermark201Response

Generate document

Merges template with data and returns base64 encoded document or a public URL to a document. NB! When the public URL option is used, the document is stored for 30 days and automatically deleted.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: JSONWebTokenAuth
$config = PDFGeneratorAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new PDFGeneratorAPI\Api\DocumentsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$generate_document_request = new \PDFGeneratorAPI\Model\GenerateDocumentRequest(); // \PDFGeneratorAPI\Model\GenerateDocumentRequest | Request parameters, including template id, data and formats.

try {
    $result = $apiInstance->generateDocument($generate_document_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentsApi->generateDocument: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
generate_document_request	\PDFGeneratorAPI\Model\GenerateDocumentRequest	Request parameters, including template id, data and formats.

Return type

\PDFGeneratorAPI\Model\AddWatermark201Response

Authorization

JSONWebTokenAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`generateDocumentAsynchronous()`

generateDocumentAsynchronous($generate_document_asynchronous_request): \PDFGeneratorAPI\Model\GenerateDocumentAsynchronous201Response

Generate document (async)

Merges template with data as asynchronous job and makes POST request to callback URL defined in the request. Request uses the same format as response of synchronous generation endpoint. The job id is also added to the callback request as header PDF-API-Job-Id Example payload for callback URL: { \"response\": \"https://us1.pdfgeneratorapi.com/share/12821/VBERi0xLjcKJeLjz9MKNyAwIG9i\", \"meta\": { \"name\": \"a2bd25b8921f3dc7a440fd7f427f90a4.pdf\", \"display_name\": \"a2bd25b8921f3dc7a440fd7f427f90a4\", \"encoding\": \"binary\", \"content-type\": \"application/pdf\" } }

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: JSONWebTokenAuth
$config = PDFGeneratorAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new PDFGeneratorAPI\Api\DocumentsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$generate_document_asynchronous_request = new \PDFGeneratorAPI\Model\GenerateDocumentAsynchronousRequest(); // \PDFGeneratorAPI\Model\GenerateDocumentAsynchronousRequest | Request parameters, including template id, data and formats.

try {
    $result = $apiInstance->generateDocumentAsynchronous($generate_document_asynchronous_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentsApi->generateDocumentAsynchronous: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
generate_document_asynchronous_request	\PDFGeneratorAPI\Model\GenerateDocumentAsynchronousRequest	Request parameters, including template id, data and formats.

Return type

\PDFGeneratorAPI\Model\GenerateDocumentAsynchronous201Response

Authorization

JSONWebTokenAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`generateDocumentBatch()`

generateDocumentBatch($generate_document_batch_request): \PDFGeneratorAPI\Model\AddWatermark201Response

Generate document (batch)

Allows to merge multiple templates with data and returns base64 encoded document or public URL to a document. NB! When the public URL option is used, the document is stored for 30 days and automatically deleted.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: JSONWebTokenAuth
$config = PDFGeneratorAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new PDFGeneratorAPI\Api\DocumentsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$generate_document_batch_request = new \PDFGeneratorAPI\Model\GenerateDocumentBatchRequest(); // \PDFGeneratorAPI\Model\GenerateDocumentBatchRequest | Request parameters, including template id, data and formats.

try {
    $result = $apiInstance->generateDocumentBatch($generate_document_batch_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentsApi->generateDocumentBatch: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
generate_document_batch_request	\PDFGeneratorAPI\Model\GenerateDocumentBatchRequest	Request parameters, including template id, data and formats.

Return type

\PDFGeneratorAPI\Model\AddWatermark201Response

Authorization

JSONWebTokenAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`generateDocumentBatchAsynchronous()`

generateDocumentBatchAsynchronous($generate_document_batch_asynchronous_request): \PDFGeneratorAPI\Model\GenerateDocumentAsynchronous201Response

Generate document (batch + async)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: JSONWebTokenAuth
$config = PDFGeneratorAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new PDFGeneratorAPI\Api\DocumentsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$generate_document_batch_asynchronous_request = new \PDFGeneratorAPI\Model\GenerateDocumentBatchAsynchronousRequest(); // \PDFGeneratorAPI\Model\GenerateDocumentBatchAsynchronousRequest | Request parameters, including template id, data and formats.

try {
    $result = $apiInstance->generateDocumentBatchAsynchronous($generate_document_batch_asynchronous_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentsApi->generateDocumentBatchAsynchronous: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
generate_document_batch_asynchronous_request	\PDFGeneratorAPI\Model\GenerateDocumentBatchAsynchronousRequest	Request parameters, including template id, data and formats.

Return type

\PDFGeneratorAPI\Model\GenerateDocumentAsynchronous201Response

Authorization

JSONWebTokenAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getDocument()`

getDocument($public_id): \PDFGeneratorAPI\Model\GetDocument200Response

Get document

Returns document stored in the Document Storage

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: JSONWebTokenAuth
$config = PDFGeneratorAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new PDFGeneratorAPI\Api\DocumentsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$public_id = bac8381bce1982e5f6957a0f52371336; // string | Resource public id

try {
    $result = $apiInstance->getDocument($public_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentsApi->getDocument: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
public_id	string	Resource public id

Return type

\PDFGeneratorAPI\Model\GetDocument200Response

Authorization

JSONWebTokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getDocuments()`

getDocuments($template_id, $start_date, $end_date, $page, $per_page): \PDFGeneratorAPI\Model\GetDocuments200Response

Get documents

Returns a list of generated documents created by authorized workspace and stored in PDF Generator API. If master user is specified as workspace in JWT then all documents created in the organization are returned. NB! This endpoint returns only documents generated using the output=url option.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: JSONWebTokenAuth
$config = PDFGeneratorAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new PDFGeneratorAPI\Api\DocumentsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$template_id = 19375; // int | Template unique identifier
$start_date = 2022-08-01 12:00:00; // string | Start date. Format: Y-m-d H:i:s
$end_date = 2022-08-05 12:00:00; // string | End date. Format: Y-m-d H:i:s. Defaults to current timestamp
$page = 1; // int | Pagination: page to return
$per_page = 20; // int | Pagination: How many records to return per page

try {
    $result = $apiInstance->getDocuments($template_id, $start_date, $end_date, $page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentsApi->getDocuments: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
template_id	int	Template unique identifier	[optional]
start_date	string	Start date. Format: Y-m-d H:i:s	[optional]
end_date	string	End date. Format: Y-m-d H:i:s. Defaults to current timestamp	[optional]
page	int	Pagination: page to return	[optional] [default to 1]
per_page	int	Pagination: How many records to return per page	[optional] [default to 15]

Return type

\PDFGeneratorAPI\Model\GetDocuments200Response

Authorization

JSONWebTokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

DocumentsApi.md

Latest commit

History

DocumentsApi.md

File metadata and controls

PDFGeneratorAPI\DocumentsApi

deleteDocument()

Example

Parameters

Return type

Authorization

HTTP request headers

generateDocument()

Example

Parameters

Return type

Authorization

HTTP request headers

generateDocumentAsynchronous()

Example

Parameters

Return type

Authorization

HTTP request headers

generateDocumentBatch()

Example

Parameters

Return type

Authorization

HTTP request headers

generateDocumentBatchAsynchronous()

Example

Parameters

Return type

Authorization

HTTP request headers

getDocument()

Example

Parameters

Return type

Authorization

HTTP request headers

getDocuments()

Example

Parameters

Return type

Authorization

HTTP request headers

`deleteDocument()`

`generateDocument()`

`generateDocumentAsynchronous()`

`generateDocumentBatch()`

`generateDocumentBatchAsynchronous()`

`getDocument()`

`getDocuments()`