Using DocAssurance API
The DocAssurance service provides the ability to perform various digital signature or encryption operations with PDF documents, such as signing, certification, addition of signature fields, encryption, decryption etc.
This article provides you java code snippets to get you started using the API.The code snippet makes use of access token. This article explains the steps needed to generate access token
This feature is available under early adopter program. You can write to aem-forms-ea@adobe.com from your official email id to join the early adopter program and request access to this functionality
Prerequistes
- Experience with AEM Forms Cloud Service
- Experience in using Apache HTTP Components
- Access to AEM Forms Cloud Service environment
Inspect Document
Use the inspect API to fetch the type of security on a given PDF document. The following code snippet should help you to get started.
...
File fileToInspect = new File("path_to_your_pdf_file)";
HttpPost httpPost = new HttpPost("<your_aem_forms_instance>/adobe/forms/document/assure/inspect");
httpPost.addHeader("Authorization", "Bearer " + accessToken);
MultipartEntityBuilder builder = MultipartEntityBuilder.create();
byte[] fileContent = FileUtils.readFileToByteArray(fileToInspect);
builder.addBinaryBody("document", fileContent, ContentType.create("application/pdf"), "BenefitOverview.pdf");
try
{
HttpEntity entity = builder.build();
httpPost.setEntity(entity);
CloseableHttpClient httpclient = HttpClients.createDefault();
CloseableHttpResponse response = httpclient.execute(httpPost);
if (response.getStatusLine().getStatusCode() == 200)
{
String json = EntityUtils.toString(response.getEntity(), StandardCharsets.UTF_8);
log.info("The mode of encryption is " + JsonParser.parseString(json).getAsJsonObject().get("mode").getAsString());
}
}
catch (Exception e)
{
log.error(e.getMessage());
}
...
Encrypt document
Use the Encrypt API to encrypt pdf documents with password. The following sample code snippet encrypts a given PDF.
...
File fileToEncrypt = new File("path_to_your_pdf_file");
HttpPost httpPost = new HttpPost(postURL);
httpPost.addHeader("Authorization", "Bearer " + accessToken ");
MultipartEntityBuilder builder = MultipartEntityBuilder.create(); byte[] fileContent = FileUtils.readFileToByteArray(fileToEncrypt); builder.addBinaryBody("document", fileContent, ContentType.create("application/pdf"), "BenefitOverview.pdf");
String config = "{\"mode\":\"ENCRYPT_WITH_PASSWORD\",\"params\":{\"openPassword\":\"adobe\",\"permPassword\":\"systems\",\"permissions\":[\"ALL_PERM\"]}}";
builder.addTextBody("config", config, ContentType.APPLICATION_JSON);
try
{
HttpEntity entity = builder.build();
httpPost.setEntity(entity);
CloseableHttpClient httpclient = HttpClients.createDefault();
CloseableHttpResponse response = httpclient.execute(httpPost);
if (response.getStatusLine().getStatusCode() == 200)
{
InputStream generatedPDF = response.getEntity().getContent();
byte[] bytes = IOUtils.toByteArray(generatedPDF);
File encryptedFile = new File("c:\\aem_forms_cs_api\\encrypted.pdf");
FileOutputStream outputStream = new FileOutputStream(encryptedFile);
outputStream.write(bytes);
outputStream.close();
}
}
catch (Exception e)
{
log.error(e.getMessage());
}
...
Add signature field to pdf
Use the signfield API to add a signature to the supplied PDF. The following sample code snippet adds a signature field called SignHere on page 4 of the document
...
File pdfFile = new File(pdfFile1.getPath());
HttpPost httpPost = new HttpPost(postURL);
httpPost.addHeader("Authorization", "Bearer "+accessToken);
MultipartEntityBuilder builder = MultipartEntityBuilder.create();
byte[] fileContent = FileUtils.readFileToByteArray(pdfFile);
builder.addBinaryBody("document", fileContent, ContentType.create("application/pdf"), "BenefitOverview.pdf");
builder.addTextBody("field", "SignHere", ContentType.TEXT_PLAIN);
String rectangle = "{\"lowerLeftX\":1,\"lowerLeftY\":40,\"width\":100,\"height\":100}";
builder.addTextBody("rectangle", rectangle, ContentType.APPLICATION_JSON);
Remove encryption
Use the PUT operation on the encrypt API to remove encryption from the supplied PDF. The following Java code snippet should help you get started.
...
File fileToDecrypt = new File("path_to_your_pdf_file");
HttpPut httpPut = new HttpPut(putURL);
httpPut.addHeader("Authorization", "Bearer " + accessToken);
MultipartEntityBuilder builder = MultipartEntityBuilder.create();
byte[] fileContent = FileUtils.readFileToByteArray(fileToDecrypt);
builder.addBinaryBody("document", fileContent, ContentType.create("application/pdf"), "BenefitOverview.pdf");
builder.addTextBody("config", "systems", ContentType.TEXT_PLAIN);
try {
HttpEntity entity = builder.build();
httpPut.setEntity(entity);
CloseableHttpClient httpclient = HttpClients.createDefault();
CloseableHttpResponse response = httpclient.execute(httpPut);
if (response.getStatusLine().getStatusCode() == 200) {
InputStream generatedPDF = response.getEntity().getContent();
byte[] bytes = IOUtils.toByteArray(generatedPDF);
File encryptionRemoved = new File("c:\\aem_forms_cs_api\\encryption_removed.pdf");
FileOutputStream outputStream = new FileOutputStream(encryptionRemoved);
outputStream.write(bytes);
outputStream.close();
httpclient.close();
}
} catch (Exception e) {
log.error(e.getMessage());
}
...
Postman collection
A Postman collection of the API can be downloaded from here for testing purposes. You can use Basic Authentication or Bearer Token type of authentication to invoke the API.