Quickstart for Adobe PDF Electronic Seal API (Java)
To get started using Adobe PDF Electronic Seal API, let's walk through a simple scenario - Applying an electronic seal on an invoice PDF document. In this guide, we will walk you through the complete process for creating a program that will accomplish this task.
Prerequisites
To complete this guide, you will need:
- Java - Java 11 or higher is required.
- Maven
- An Adobe ID. If you do not have one, the credential setup will walk you through creating one.
- A way to edit code. No specific editor is required for this guide.
Step One: Getting credentials
1) To begin, open your browser to https://acrobatservices.adobe.com/dc-integration-creation-app-cdn/main.html?api=pdf-services-api. If you are not already logged in to Adobe.com, you will need to sign in or create a new user. Using a personal email account is recommended and not a federated ID.
2) After registering or logging in, you will then be asked to name your new credentials. Use the name, "New Project".
3) Change the "Choose language" setting to "Java".
4) Also note the checkbox by, "Create personalized code sample." This will include a large set of samples along with your credentials. These can be helpful for learning more later.
5) Click the checkbox saying you agree to the developer terms and then click "Create credentials."
6) After your credentials are created, they are automatically downloaded:
Step Two: Setting up the project
1) In your Downloads folder, find the ZIP file with your credentials: PDFServicesSDK-JavaSamples.zip. If you unzip that archive, you will find a folder of samples and the pdfservices-api-credentials.json
file.
2) Take the pdfservices-api-credentials.json
and place it in a new directory.
3) In this directory, create a new file named pom.xml
and copy the following content:
Copied to your clipboard1<?xml version="1.0" encoding="UTF-8"?>23<project xmlns="http://maven.apache.org/POM/4.0.0"4 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"5 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">6 <modelVersion>4.0.0</modelVersion>78 <groupId>com.adobe.documentservices</groupId>9 <artifactId>pdfservices-sdk-electronicseal-guide</artifactId>10 <version>1</version>1112 <name>PDF Services Java SDK Samples</name>1314 <properties>15 <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>16 <maven.compiler.source>11</maven.compiler.source>17 <maven.compiler.target>11</maven.compiler.target>18 <pdfservices.sdk.version>4.0.0</pdfservices.sdk.version>19 </properties>2021 <dependencies>2223 <dependency>24 <groupId>com.adobe.documentservices</groupId>25 <artifactId>pdfservices-sdk</artifactId>26 <version>${pdfservices.sdk.version}</version>27 </dependency>2829 <!-- log4j2 dependency to showcase the use of log4j2 with slf4j API-->30 <!-- https://mvnrepository.com/artifact/org.slf4j/slf4j-log4j12 -->31 <dependency>32 <groupId>org.apache.logging.log4j</groupId>33 <artifactId>log4j-slf4j-impl</artifactId>34 <version>2.21.1</version>35 </dependency>36 </dependencies>3738 <build>39 <plugins>40 <plugin>41 <groupId>org.apache.maven.plugins</groupId>42 <artifactId>maven-compiler-plugin</artifactId>43 <version>3.8.0</version>44 <configuration>45 <source>${maven.compiler.source}</source>46 <target>${maven.compiler.target}</target>47 </configuration>48 </plugin>49 <plugin>50 <groupId>org.codehaus.mojo</groupId>51 <artifactId>exec-maven-plugin</artifactId>52 <version>1.5.0</version>53 <executions>54 <execution>55 <goals>56 <goal>java</goal>57 </goals>58 </execution>59 </executions>60 </plugin>61 </plugins>62 </build>63</project>
This file will define what dependencies we need and how the application will be built.
Our application will take an Invoice PDF document, sampleInvoice.pdf
(downloadable from here), and will use the sealing options with default appearance options to apply electronic seal over the PDF document by invoking Acrobat Services API and generate an electronically sealed PDF.
4) In your editor, open the directory where you previously copied the credentials, and create a new directory, src/main/java
. In that directory, create ElectronicSeal.java
.
Now you're ready to begin coding.
Step Three: Creating the application
1) We will begin by including the required dependencies:
Copied to your clipboard1import com.adobe.pdfservices.operation.PDFServices;2import com.adobe.pdfservices.operation.PDFServicesMediaType;3import com.adobe.pdfservices.operation.PDFServicesResponse;4import com.adobe.pdfservices.operation.auth.Credentials;5import com.adobe.pdfservices.operation.auth.ServicePrincipalCredentials;6import com.adobe.pdfservices.operation.exception.SDKException;7import com.adobe.pdfservices.operation.exception.ServiceApiException;8import com.adobe.pdfservices.operation.exception.ServiceUsageException;9import com.adobe.pdfservices.operation.io.Asset;10import com.adobe.pdfservices.operation.io.StreamAsset;11import com.adobe.pdfservices.operation.pdfjobs.jobs.PDFElectronicSealJob;12import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.AppearanceItem;13import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.AppearanceOptions;14import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.CSCAuthContext;15import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.CertificateCredentials;16import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.FieldLocation;17import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.FieldOptions;18import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.PDFElectronicSealParams;19import com.adobe.pdfservices.operation.pdfjobs.result.PDFElectronicSealResult;20import org.apache.commons.io.IOUtils;21import org.slf4j.Logger;22import org.slf4j.LoggerFactory;2324import java.io.File;25import java.io.IOException;26import java.io.InputStream;27import java.io.OutputStream;28import java.nio.file.Files;29import java.nio.file.Paths;
2) Now let's define our main class:
Copied to your clipboard1public class ElectronicSeal {23 // Initialize the logger.4 private static final Logger LOGGER = LoggerFactory.getLogger(ElectronicSeal.class);56 public static void main(String[] args) {78 }9}
3) Set the environment variables PDF_SERVICES_CLIENT_ID
and PDF_SERVICES_CLIENT_SECRET
by running the following commands and replacing placeholders YOUR CLIENT ID
and YOUR CLIENT SECRET
with the credentials present in pdfservices-api-credentials.json
file:
Windows:
set PDF_SERVICES_CLIENT_ID=<YOUR CLIENT ID>
set PDF_SERVICES_CLIENT_SECRET=<YOUR CLIENT SECRET>
MacOS/Linux:
export PDF_SERVICES_CLIENT_ID=<YOUR CLIENT ID>
export PDF_SERVICES_CLIENT_SECRET=<YOUR CLIENT SECRET>
4) Next, we can create our credentials and PDFServices instance:
Copied to your clipboard1// Initial setup, create credentials instance2Credentials credentials = new ServicePrincipalCredentials(3 System.getenv("PDF_SERVICES_CLIENT_ID"),4 System.getenv("PDF_SERVICES_CLIENT_SECRET"));56// Creates a PDF Services instance7PDFServices pdfServices = new PDFServices(credentials);
5) Now, let's upload the asset:
Copied to your clipboard1// Create assets from source files and upload2Asset asset = pdfServices.upload(inputStream, PDFServicesMediaType.PDF.getMediaType());3Asset sealImageAsset = pdfServices.upload(inputStreamSealImage, PDFServicesMediaType.PNG.getMediaType());
6) Now, we will define the document level permission:
Copied to your clipboard1// Set the document level permission to be applied for output document2DocumentLevelPermission documentLevelPermission = DocumentLevelPermission.FORM_FILLING;
7) Now, we will define seal field options:
Copied to your clipboard1// Create AppearanceOptions and add the required signature display items to it2AppearanceOptions appearanceOptions = new AppearanceOptions();3appearanceOptions.addItem(AppearanceItem.NAME);4appearanceOptions.addItem(AppearanceItem.LABELS);5appearanceOptions.addItem(AppearanceItem.DATE);6appearanceOptions.addItem(AppearanceItem.SEAL_IMAGE);7appearanceOptions.addItem(AppearanceItem.DISTINGUISHED_NAME);89// Sets the Seal Field Name to be created in input PDF document.10String sealFieldName = "Signature1";1112// Sets the page number in input document for applying seal.13Integer sealPageNumber = 1;1415// Sets if seal should be visible or invisible.16Boolean sealVisible = true;1718// Creates FieldLocation instance and set the coordinates for applying signature19FieldLocation fieldLocation = new FieldLocation(150, 250, 350, 200);2021// Create FieldOptions instance with required details.22FieldOptions fieldOptions = new FieldOptions.Builder(sealFieldName)23 .setFieldLocation(fieldLocation)24 .setPageNumber(sealPageNumber)25 .setVisible(sealVisible)26 .build();
8) Next, we create a CSC Certificate Credentials instance:
Copied to your clipboard1// Sets the name of TSP Provider being used.2String providerName = "<PROVIDER_NAME>";34// Sets the access token to be used to access TSP provider hosted APIs.5String accessToken = "<ACCESS_TOKEN>";67// Sets the credential ID.8String credentialID = "<CREDENTIAL_ID>";910// Sets the PIN generated while creating credentials.11String pin = "<PIN>";1213// Creates CSCAuthContext instance using access token and token type.14CSCAuthContext cscAuthContext = new CSCAuthContext(accessToken, "Bearer");1516// Create CertificateCredentials instance with required certificate details.17CertificateCredentials certificateCredentials = CertificateCredentials.cscCredentialBuilder()18 .withProviderName(providerName)19 .withCredentialID(credentialID)20 .withPin(pin)21 .withCSCAuthContext(cscAuthContext)22 .build();
9) Now, let's create the job with seal parameters using certificate credentials and field options and set the seal image asset:
Copied to your clipboard1// Create parameters for the job2PDFElectronicSealParams pdfElectronicSealParams = PDFElectronicSealParams3 .pdfElectronicSealParamsBuilder(certificateCredentials, fieldOptions)4 .withAppearanceOptions(appearanceOptions)5 .build();67// Creates a new job instance8PDFElectronicSealJob pdfElectronicSealJob = new PDFElectronicSealJob(asset, pdfElectronicSealParams);910// Sets the optional input seal image for PDFElectronicSealOperation instance11pdfElectronicSealJob.setSealImageAsset(sealImageAsset);
This set of code defines what we're doing (an Electronic Seal operation), it defines parameters for the seal job and sets input seal image asset.
10) The next code block submits the job and gets the job result:
Copied to your clipboard1// Submit the job and gets the job result2String location = pdfServices.submit(pdfElectronicSealJob);3PDFServicesResponse<PDFElectronicSealResult> pdfServicesResponse = pdfServices.getJobResult(location, PDFElectronicSealResult.class);45// Get content from the resulting asset(s)6Asset resultAsset = pdfServicesResponse.getResult().getAsset();7StreamAsset streamAsset = pdfServices.getContent(resultAsset);
11) The next code block saves the result at the specified location:
Copied to your clipboard1// Creates an output stream and copy stream asset's content to it2OutputStream outputStream = Files.newOutputStream(new File("output/sealedOutput.pdf").toPath());3IOUtils.copy(streamAsset.getInputStream(), outputStream);
Here's the complete application (src/main/java/ElectronicSeal.java
):
Copied to your clipboard1import com.adobe.pdfservices.operation.PDFServices;2import com.adobe.pdfservices.operation.PDFServicesMediaType;3import com.adobe.pdfservices.operation.PDFServicesResponse;4import com.adobe.pdfservices.operation.auth.Credentials;5import com.adobe.pdfservices.operation.auth.ServicePrincipalCredentials;6import com.adobe.pdfservices.operation.exception.SDKException;7import com.adobe.pdfservices.operation.exception.ServiceApiException;8import com.adobe.pdfservices.operation.exception.ServiceUsageException;9import com.adobe.pdfservices.operation.io.Asset;10import com.adobe.pdfservices.operation.io.StreamAsset;11import com.adobe.pdfservices.operation.pdfjobs.jobs.PDFElectronicSealJob;12import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.AppearanceItem;13import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.AppearanceOptions;14import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.CSCAuthContext;15import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.CertificateCredentials;16import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.DocumentLevelPermission;17import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.FieldLocation;18import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.FieldOptions;19import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.PDFElectronicSealParams;20import com.adobe.pdfservices.operation.pdfjobs.result.PDFElectronicSealResult;21import org.apache.commons.io.IOUtils;22import org.slf4j.Logger;23import org.slf4j.LoggerFactory;2425import java.io.File;26import java.io.IOException;27import java.io.InputStream;28import java.io.OutputStream;29import java.nio.file.Files;30import java.nio.file.Paths;3132public class ElectronicSeal {3334 // Initialize the logger.35 private static final Logger LOGGER = LoggerFactory.getLogger(ElectronicSeal.class);3637 public static void main(String[] args) {38 try (InputStream inputStream = Files.newInputStream(new File("src/main/resources/sampleInvoice.pdf").toPath());39 InputStream inputStreamSealImage = Files.newInputStream(new File("src/main/resources/sampleSealImage.png").toPath())) {40 // Initial setup, create credentials instance41 Credentials credentials = new ServicePrincipalCredentials(42 System.getenv("PDF_SERVICES_CLIENT_ID"),43 System.getenv("PDF_SERVICES_CLIENT_SECRET"));4445 // Creates a PDF Services instance46 PDFServices pdfServices = new PDFServices(credentials);4748 // Create assets from source files and upload49 Asset asset = pdfServices.upload(inputStream, PDFServicesMediaType.PDF.getMediaType());50 Asset sealImageAsset = pdfServices.upload(inputStreamSealImage, PDFServicesMediaType.PNG.getMediaType());5152 // Set the document level permission to be applied for output document53 DocumentLevelPermission documentLevelPermission = DocumentLevelPermission.FORM_FILLING;5455 // Create AppearanceOptions and add the required signature display items to it56 AppearanceOptions appearanceOptions = new AppearanceOptions();57 appearanceOptions.addItem(AppearanceItem.NAME);58 appearanceOptions.addItem(AppearanceItem.LABELS);59 appearanceOptions.addItem(AppearanceItem.DATE);60 appearanceOptions.addItem(AppearanceItem.SEAL_IMAGE);61 appearanceOptions.addItem(AppearanceItem.DISTINGUISHED_NAME);6263 // Sets the Seal Field Name to be created in input PDF document.64 String sealFieldName = "Signature1";6566 // Sets the page number in input document for applying seal.67 Integer sealPageNumber = 1;6869 // Sets if seal should be visible or invisible.70 Boolean sealVisible = true;7172 // Creates FieldLocation instance and set the coordinates for applying signature73 FieldLocation fieldLocation = new FieldLocation(150, 250, 350, 200);7475 // Create FieldOptions instance with required details.76 FieldOptions fieldOptions = new FieldOptions.Builder(sealFieldName)77 .setFieldLocation(fieldLocation)78 .setPageNumber(sealPageNumber)79 .setVisible(sealVisible)80 .build();8182 //Set the name of TSP Provider being used.83 String providerName = "<PROVIDER_NAME>";8485 // Sets the access token to be used to access TSP provider hosted APIs.86 String accessToken = "<ACCESS_TOKEN>";8788 // Sets the credential ID.89 String credentialID = "<CREDENTIAL_ID>";9091 // Sets the PIN generated while creating credentials.92 String pin = "<PIN>";9394 // Creates CSCAuthContext instance using access token and token type.95 CSCAuthContext cscAuthContext = new CSCAuthContext(accessToken, "Bearer");9697 // Create CertificateCredentials instance with required certificate details.98 CertificateCredentials certificateCredentials = CertificateCredentials.cscCredentialBuilder()99 .withProviderName(providerName)100 .withCredentialID(credentialID)101 .withPin(pin)102 .withCSCAuthContext(cscAuthContext)103 .build();104105 // Create parameters for the job106 PDFElectronicSealParams pdfElectronicSealParams = PDFElectronicSealParams107 .pdfElectronicSealParamsBuilder(certificateCredentials, fieldOptions)108 .withDocumentLevelPermission(documentLevelPermission)109 .withAppearanceOptions(appearanceOptions)110 .build();111112 // Creates a new job instance113 PDFElectronicSealJob pdfElectronicSealJob = new PDFElectronicSealJob(asset, pdfElectronicSealParams);114115 // Sets the optional input seal image for PDFElectronicSealOperation instance116 pdfElectronicSealJob.setSealImageAsset(sealImageAsset);117118 // Submit the job and gets the job result119 String location = pdfServices.submit(pdfElectronicSealJob);120 PDFServicesResponse<PDFElectronicSealResult> pdfServicesResponse = pdfServices.getJobResult(location, PDFElectronicSealResult.class);121122 // Get content from the resulting asset(s)123 Asset resultAsset = pdfServicesResponse.getResult().getAsset();124 StreamAsset streamAsset = pdfServices.getContent(resultAsset);125126 // Creates an output stream and copy stream asset's content to it127 Files.createDirectories(Paths.get("output/"));128 OutputStream outputStream = Files.newOutputStream(new File("output/sealedOutput.pdf").toPath());129 LOGGER.info("Saving asset at output/sealedOutput.pdf");130 IOUtils.copy(streamAsset.getInputStream(), outputStream);131 outputStream.close();132 } catch (ServiceApiException | IOException | SDKException | ServiceUsageException ex) {133 LOGGER.error("Exception encountered while executing operation", ex);134 }135 }136}
Next Steps
Now that you've successfully performed your first operation, review the documentation for many other examples and reach out on our forums with any questions. Also remember the samples you downloaded while creating your credentials also have many demos.