Version - Support policy

This document describes the PDF Services SDK's and Public API's versioning and support policies.

SDK

Versioning scheme

The SDK has a version format of #.#.# (e.g. 1.1.0) where the numbers correspond to a major release, minor release, and patch/update (Major.Minor.Patch). Releases are defined as follows:

Major Releases (1.x.x): Major releases introduce backward-incompatible changes to the APIs and interfaces and start the EOL clock for all previous releases. Developers should plan on migrating their code prior to the end of life of the previous major release.
Minor Releases (x.1.x): Minor releases typically appear quarterly. Changes are backward compatible to the last major release. Minor releases introduce new interfaces. Existing interfaces continue to function but some interfaces may be deprecated; deprecated interfaces will be removed in a next major release.
Patch Releases (x.x.1): Patch releases only deliver critical security or bug fixes as needed. Patch release changes are rolled into the next minor release so that developers can update and deploy new code based on their business requirements.

Public API

Versioning

As mentioned on Public API Docs, each operation has a unique assetId which is passed in Form Parameters. Generally, APIs will be enhanced while keeping them backward compatible. If its functionality can't be enhanced without breaking changes, then its new version will be released with its own unique assetId. The supported older API versions info will be present on Public API Docs

Additionally, the output for the PDF Extract API is generated by a machine learning pipeline that is frequently trained to improve inference of document layout and structure.As a result, while changes to the output structure are not expected between versions, specific results may vary as the model output improves.

Supported versions

This document as well as the URLs on Adobe's website and other documentation link to the latest product version.

Note: Links to repository assets (e.g. GIT, Maven, etc.) direct to the top level directory. To download assets that match the documentation, navigate to the correct version. For example, When using the 1.0.0 Java documentation, you can find the 1.0.0 samples in the GIT repo as follows:

Go to the GIT repo.
Select Releases.
Select and download the needed release.

Previous Release tags with release notes and links to the assets

Migration Guide to PDF Services SDK

Refer to the following table for migrating to PDF Services SDK version 3.4.0, you can also refer our Samples( Java, Node JS, .NET). for the latest release.

The 1.X.X versions of PDF Tools SDK will be reaching End of Life in May 2022. Once a version reaches its end of life, functionality may be deprecated and stop working. Please upgrade to use our latest SDK version.

Java changes

artifactId changed from pdftools-sdk to pdfservices-sdk
Replace the <properties> tag and SDK <dependency> tag in your project’s pom.xml file with the following:

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>11</maven.compiler.source>
    <maven.compiler.target>11</maven.compiler.target>
    <pdfservices.sdk.version>4.1.0</pdfservices.sdk.version>
    <pdfservices.sdk.samples.version>4.1.0</pdfservices.sdk.samples.version>
</properties>

<dependency>
    <groupId>com.adobe.documentservices</groupId>
    <artifactId>pdfservices-sdk</artifactId>
    <version>${pdfservices.sdk.version}</version>
</dependency>
Copied to your clipboard
<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>11</maven.compiler.source>
    <maven.compiler.target>11</maven.compiler.target>
    <pdfservices.sdk.version>4.1.0</pdfservices.sdk.version>
    <pdfservices.sdk.samples.version>4.1.0</pdfservices.sdk.samples.version>
</properties>

<dependency>
    <groupId>com.adobe.documentservices</groupId>
    <artifactId>pdfservices-sdk</artifactId>
    <version>${pdfservices.sdk.version}</version>
</dependency>

Update import statements as per new Package structure. For e.g.

import com.adobe.pdfservices.operation.ExecutionContext; 
Copied to your clipboard
import com.adobe.pdfservices.operation.ExecutionContext;

Node JS changes

NPM package name changed from @adobe/documentservices-pdftools-node-sdk to @adobe/pdfservices-node-sdk
Update the latest SDK dependency in package.json file of your project

"@adobe/pdfservices-node-sdk": "4.0.1"
Copied to your clipboard
"@adobe/pdfservices-node-sdk": "4.0.1"

Require the @adobe/pdfservices-node-sdk in the Sample file to access the SDK interface

const PDFServicesSdk = require('@adobe/pdfservices-node-sdk'); 
Copied to your clipboard
const PDFServicesSdk = require('@adobe/pdfservices-node-sdk');

For HTML to PDF Conversions, the PageLayout object is moved inside html object. To access the PageLayout interface use the following code:

const pageLayout = new PDFServicesSdk.CreatePDF.options.html.PageLayout(); 
Copied to your clipboard
const pageLayout = new PDFServicesSdk.CreatePDF.options.html.PageLayout();

.NET changes

Nuget package name changed from Adobe.DocumentServices.PDFTools to Adobe.PDFServicesSDK
Update the SDK dependency in your project’s .csproj file with the following:

<ItemGroup>
    <PackageReference Include="log4net" Version="2.0.17" />
    <PackageReference Include="Adobe.PDFServicesSDK" Version="4.0.0" />
</ItemGroup> 
Copied to your clipboard
<ItemGroup>
    <PackageReference Include="log4net" Version="2.0.17" />
    <PackageReference Include="Adobe.PDFServicesSDK" Version="4.0.0" />
</ItemGroup>

Update the namespaces accordingly in your .cs file as per the new dependency:

using Adobe.PDFServicesSDK;
Copied to your clipboard
using Adobe.PDFServicesSDK;

Python changes

Add the following dependency in your project’s requirements.txt file:

pdfservices-sdk~=4.0.0
Copied to your clipboard
pdfservices-sdk~=4.0.0

Archived Documentation

The last major version of our documentation may be found here.

Change types

Change types include the following:

New: Features or implementation changes added in the current release.
Changed: Modified code that changes a feature or implementation detail.
Security: A patch or bug fixed released in an out-of-band patch.
Deprecated: Existing functionality for which support is ending (or ended).

Minor and Patch releases are backward compatible with the previous release. Upgrading to the latest SDK should not break existing applications.

Change history

September 10, 2024; Adobe Document Generation Server Side Release

Enhanced support for JSONata functions in Table Tag with Markers.

August 23, 2024; Added new features for Document Generation API and updated Acrobat Service API postman collection

Added base64 format support for inline images.
Supported attributes for img tag (height and width only).
Postman collection for external storage : Electronic Seal, Extract, Split, Accessibility Checker.
Added request body schema with example for accessibility checker with external storage.

July 30, 2024; PDF Accessibility Checker API Added

Added PDF Accessibility Checker operation in PDF Services API to check accessibility on specified pages of PDF document.

July 22, 2024; .NET SDK 4.0.0 major release

Released Adobe PDF Services .NET SDK v4.0.0, introducing new interfaces fully leveraging power of new PDF Services rest APIs.
Added support for delete asset, refresh download URI and webhook notifiers.
Eliminated need of storage to save intermediate result by removing dependency on temporary storage.
Extended I/O capabilities by introducing external storage for PDF Services operations.
Enabled connection to Internet through Proxy, where proxy server settings can be set via "proxyServerConfig" in the client config.
Updated PDF Properties operation to return PDFProperties object along with JSON string.
Updated Extract PDF operation to return content and resource asset along with content JSON object.

July 16, 2024; Server Side Release - Get PDF Properties

Bug fixes Get PDF Properties fixed data issue related to permissions in JSON response.

July 09, 2024; Server Side Release

Added PDF Watermark operation in PDF Services API to add a watermark on specified pages of PDF document.

June 12, 2024; NodeJS SDK 4.0.1 patch release

Bug fixes and stability improvements.

June 05, 2024; .NET SDK 3.5.1 patch release

Bug fixes and stability improvements.

June 04, 2024; Java SDK 4.1.0 minor release

Extend support for external storage and notifier config for all the operations.

May 22, 2024; Python SDK 4.0.0 major release

Released Adobe PDF Services Python SDK v4.0.0, introducing new interfaces fully leveraging power of new PDF Services REST APIs.
Added support for all the operations powered by the Adobe PDF Services APIs.
Added support for deleting assets and webhook notifiers.
Removed the need for intermediate result storage for chained operations by eliminating reliance on temporary local storage.
Extended I/O capabilities by introducing external storage for PDF Services operations.
Enabled connection to Internet through Proxy, where proxy server settings can be set via Proxy Server Config.

May 15, 2024; .NET SDK 3.5.0 minor release

Added support to enable or disable "configureAwait" using client config, which will allow developers to specify whether asynchronous continuations should execute on the original synchronization context or not. Note: Starting from the next major release, "configureAwait" will be disabled by default and won't be configurable.

April 30, 2024; Adobe Document Generation Server Side Release

Added support for discard the row in a horizontal table in Document Generation API.

April, 2024; NodeJS SDK 4.0.0 major release

Released Adobe PDF Services Node SDK v4.0.0, introducing new interfaces fully leveraging power of new PDF Services rest APIs.
Added support for delete asset and webhook notifiers.
Eliminated need of storage to save intermediate result by removing dependency on temporary storage.
Extended I/O capabilities by introducing external storage for PDF Services operations.
Enabled connection to Internet through Proxy, where proxy server settings can be set via "proxyServerConfig" in the client config.
Updated PDF Properties operation to return PDFProperties object along with JSON string.
Updated Extract PDF operation to return content and resource asset along with content JSON object.

April, 2024; Server Side Release

Added support for Webhook Notification in PDF Properties.
Added support for External Storage in Extract PDF, Split PDF, PDF Electronic Seal and Auto-Tag PDF.
Added support for Webhook Notification for external storage operations.

March, 2024; Python SDK 2.3.1 patch release

PDF operations now support configurable timeouts.

February, 2024: .NET SDK 3.4.1 patch release

Dependent library upgrades and fixed compatibility issues with RestSharp v110+.

January, 2024; Java SDK 4.0.0 major release

Released Adobe PDF Services Java SDK v4.0.0, introducing new interfaces fully leveraging power of new PDF Services rest APIs.
Added support for delete asset, refresh download URI, webhook notifiers.
Eliminated need of storage to save intermediate result by removing dependency on temporary storage.
Extended I/O capabilities by introducing external storage for a majority of PDF Services operations.
Updated PDF Properties operation to return PDFProperties object along with JSON string.
Updated Extract PDF operation to return content and resource asset along with content JSON object.

January, 2024; Server Side Release

Added support for Webhook Notification in all the operations except PDF Properties.

January, 2024: Adobe Document Generation Server Side Release

Added support for Table Tag with Markers in Document Generation API.

December, 2023: Java SDK 3.5.1 patch release

Dependent library upgrades and fixed compatibility issues with Spring Boot v3.x.

October, 2023: Java SDK 3.5.0 minor release

Added support for document level permissions and trusted timestamping (using supported TSAs) in java sdk for PDF Electronic Seal API.

October, 2023; Adobe Document Generation Server Side Release

Performance Improvements - Available in REST API and SDK(s) v3.0.0 and above.

August, 2023; Server Side Release

Added support for document level permissions and trusted timestamping (using supported TSAs) in PDF Electronic Seal API.
Added support for External Storage in all the operations except Extract PDF, Split PDF, PDF Electronic Seal and Auto-Tag PDF.

August, 2023, NodeJS SDK 3.4.2 minor release

Restructured the internals for improved organization.

July, 2023, NodeJS SDK 3.4.1 minor release

Fixed links in README.md file.

June, 2023; Java,NodeJS,.NET SDK 3.4.0 minor release

PDF Electronic Seal operation is now available for all the users in PDF Services SDKs and REST APIs.
Added support for OAuth based Server to Server credentials in PDF Services SDKs.
JWT based service account credentials and corresponding SDK interfaces are now deprecated.

June, 2023; Python SDK 2.3.0 minor release

Added support for OAuth based Server to Server credentials in PDF Services SDKs.
JWT based service account credentials and corresponding SDK interfaces are now deprecated.

June, 2023; Adobe Document Generation Server Side Release

Added support for External Storage in Document Generation API.

Introduction

Last updated 9/4/2024

Was this helpful?

Yes