Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added watermark and GET/SET form data operation #852

Open
wants to merge 35 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
2ac7256
Overview Index Page
May 3, 2024
3a22dbe
overview/gettingstarted
May 3, 2024
0e763a9
howtos/index
May 3, 2024
b643114
Added new params in extract pdf and fixed some bugs
May 14, 2024
e50cb3d
Merge pull request #842 from AdobeDocs/extract-changes
amitsingh1009 May 14, 2024
5eba7cc
create pdf samples
May 15, 2024
6f7e5dc
export pdf docs
May 15, 2024
71ec2a4
PDF Services first 11 operations py docs
May 15, 2024
afec50a
update dev docs for python sdk 3.0.0
paras-n May 15, 2024
5684cfd
Merge remote-tracking branch 'origin/main' into paras_python_sdk_3.0.0
paras-n May 15, 2024
b65f0b1
autotag, eseal
paras-n May 15, 2024
73a472d
autotag, extract
paras-n May 15, 2024
52a267d
docgen and eseal python dev docs
May 15, 2024
ab0a052
docs update
May 15, 2024
0cc4668
Merge branch 'python-devdocs-jasnoors' into paras_python_sdk_3.0.0
jasnoors May 15, 2024
6736d45
Merge pull request #843 from AdobeDocs/paras_python_sdk_3.0.0
jasnoors May 15, 2024
9bef54e
Merge pull request #844 from AdobeDocs/python-devdocs-jasnoors
jasnoors May 15, 2024
782dd7e
python sdk v3.0.0
paras-n May 16, 2024
6f0dd1f
Merge remote-tracking branch 'origin/paras_python_sdk_3.0.0' into par…
paras-n May 16, 2024
15c1e56
Merge remote-tracking branch 'origin/develop' into paras_python_sdk_3…
paras-n May 16, 2024
1938d87
update sdk version in hash
paras-n May 16, 2024
0d4c7e3
Merge pull request #845 from AdobeDocs/paras_python_sdk_3.0.0
paras-n May 16, 2024
953a7a0
Py SDK docs 3.0
May 16, 2024
7283824
Merge pull request #846 from AdobeDocs/py-devdocs-imports
jasnoors May 16, 2024
a083234
Merge pull request #841 from AdobeDocs/release-dotnet-3.5.0
hitesh-kumar-mahour May 16, 2024
98215f3
Update index.md
amitsingh1009 May 17, 2024
7750170
Added new operation for get/set form data
May 17, 2024
892248f
Merge pull request #849 from AdobeDocs/get-set-form
amitsingh1009 May 17, 2024
bf18064
updated the name of the api
May 17, 2024
f8774d2
Merge pull request #850 from AdobeDocs/get-set-form
amitsingh1009 May 17, 2024
6f856f0
Added new verb watermark
May 17, 2024
39ec4dc
Merge pull request #851 from AdobeDocs/watermark-api
amitsingh1009 May 17, 2024
b0a662a
removed get/set form data and watermark
May 17, 2024
d28d5dc
Added watermark and GET/SET form data operation
May 17, 2024
cf188f7
Update index.md
amitsingh1009 May 17, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions gatsby-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,10 @@ module.exports = {
{
title:'.NET',
path: 'overview/pdf-services-api/quickstarts/dotnet/index.md'
},
{
title:'Python',
path: 'overview/pdf-services-api/quickstarts/python/index.md'
}
]
},
Expand Down Expand Up @@ -396,6 +400,10 @@ module.exports = {
{
title:'.NET',
path: 'overview/document-generation-api/quickstarts/dotnet/index.md'
},
{
title:'Python',
path: 'overview/document-generation-api/quickstarts/python/index.md'
}
]

Expand Down Expand Up @@ -468,6 +476,10 @@ module.exports = {
{
title:'.NET',
path: 'overview/pdf-electronic-seal-api/quickstarts/dotnet/index.md'
},
{
title:'Python',
path: 'overview/pdf-electronic-seal-api/quickstarts/python/index.md'
}
]

Expand Down
2 changes: 1 addition & 1 deletion src/pages/apis/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Adobe PDF Services Open API spec
description: The OpenAPI spec for Adobe PDF Services API endpoints, parameters, and responses.
openAPISpec: https://raw.githubusercontent.com/AdobeDocs/pdfservices-api-documentation/main/src/pages/resources/openapi.json
openAPISpec: https://raw.githubusercontent.com/AdobeDocs/pdfservices-api-documentation/watermark-and-form/src/pages/resources/openapi.json
---
215 changes: 213 additions & 2 deletions src/pages/overview/document-generation-api/gettingstarted.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ Want to quickly test out Document Generation API? The following quickstarts will

* [Node.js](nodejs/)
* [Java](java/)
* [.NET](dotnet)
* [.NET](dotnet/)
* [Python](python)
289 changes: 289 additions & 0 deletions src/pages/overview/document-generation-api/quickstarts/python/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,289 @@
---
title: Python | Quickstarts | Document Generation API | Adobe PDF Services
---

# Quickstart for Adobe Document Generation API (Python)

To get started using Adobe Document Generation API, let's walk through a simple scenario - using a Word document as a template for dynamic receipt generation in PDF. 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:

* [Python](https://www.python.org/downloads/) - Python 3.10 or higher is required.
* 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 recommend and not a federated ID.

![Sign in](./shot1.png)

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 "Python".

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."

![Project setup](./shot2_spc.png)

6) After your credentials are created, they are automatically downloaded:

![Credentials](./shot3_spc.png)

## Step Two: Setting up the project

1) In your Downloads folder, find the ZIP file with your credentials: PDFServicesSDK-Python (Extract, Auto-tag)Samples.zip. If you unzip that archive, you will find a folder of samples and the `pdfservices-api-credentials.json` file.

![Samples](./shot5_spc.png)

2) Take the `pdfservices-api-credentials.json` file and place it in a new directory.

3) At the command line, change to the directory you created, and run the following command to install the Python SDK: `pip install pdfservices-sdk`.

![alt](shot7.png)

At this point, we've installed the Python SDK for Adobe PDF Services API as a dependency for our project and have copied over our credentials files.

Our application will take a Word document, `receiptTemplate.docx` (downloadable from [here](/receiptTemplate.docx)), and combine it with data in a JSON file, `receipt.json` (downloadable from [here](/receipt.json)), to be sent to the Acrobat Services API and generate a receipt PDF.

4) In your editor, open the directory where you previously copied the credentials. Create a new file, `generate_pdf.py`.

Now you're ready to begin coding.

## Step Three: Creating the application

1) Let's start by looking at the Word template. If you open the document in Microsoft Word, you'll notice multiple tokens throughout the document (called out by the use of `{{` and `}}`).

![Example of tokens](./shot10.png)

2) Next, let's look at our sample data:

```json
{
"author": "Gary Lee",
"Company": {
"Name": "Projected",
"Address": "19718 Mandrake Way",
"PhoneNumber": "+1-100000098"
},
"Invoice": {
"Date": "January 15, 2021",
"Number": 123,
"Items": [
{
"item": "Gloves",
"description": "Microwave gloves",
"UnitPrice": 5,
"Quantity": 2,
"Total": 10
},
{
"item": "Bowls",
"description": "Microwave bowls",
"UnitPrice": 10,
"Quantity": 2,
"Total": 20
}
]
},
"Customer": {
"Name": "Collins Candy",
"Address": "315 Dunning Way",
"PhoneNumber": "+1-200000046",
"Email": "[email protected]"
},
"Tax": 5,
"Shipping": 5,
"clause": {
"overseas": "The shipment might take 5-10 more than informed."
},
"paymentMethod": "Cash"
}
```

Notice how the tokens in the Word document match up with values in our JSON. While our example will use a hard coded set of data in a file, production applications can get their data from anywhere. Now let's get into our code.

3) We'll begin by including our required dependencies:

```python
import logging
import os
from datetime import datetime

from adobe.pdfservices.operation.auth.service_principal_credentials import ServicePrincipalCredentials
from adobe.pdfservices.operation.exception.exceptions import ServiceApiException, ServiceUsageException, SdkException
from adobe.pdfservices.operation.io.cloud_asset import CloudAsset
from adobe.pdfservices.operation.io.stream_asset import StreamAsset
from adobe.pdfservices.operation.pdf_services import PDFServices
from adobe.pdfservices.operation.pdf_services_media_type import PDFServicesMediaType
from adobe.pdfservices.operation.pdfjobs.jobs.document_merge_job import DocumentMergeJob
from adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params import DocumentMergeParams
from adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format import OutputFormat
from adobe.pdfservices.operation.pdfjobs.result.document_merge_result import DocumentMergePDFResult
```

4) 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>`

5) Next, we can create our credentials and use them:

```python
# Initial setup, create credentials instance
credentials = ServicePrincipalCredentials(
client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET'))

# Creates a PDF Services instance
pdf_services = PDFServices(credentials=credentials)
```

6) Now, let's create an assets from source file and upload.

```python
file = open('./receiptTemplate.docx', 'rb')
input_stream = file.read()
file.close()

# Creates an asset(s) from source file(s) and upload
input_asset = pdf_services.upload(input_stream=input_stream,
mime_type=PDFServicesMediaType.PDF)
```

7) Now, let's create the parameters and the job:

```python
# Setup input data for the document merge process
with open('./receipt.json', 'r') as file:
content_string = file.read()
json_data_for_merge = json.loads(content_string)

# Create parameters for the job
document_merge_params = DocumentMergeParams(json_data_for_merge=json_data_for_merge,
output_format=OutputFormat.PDF)

# Creates a new job instance
document_merge_job = DocumentMergeJob(input_asset=input_asset,
document_merge_params=document_merge_params)
```

This set of code defines what we're doing (a document merge operation, the SDK's way of describing Document Generation), points to our local JSON file and specifies the output is a PDF. It also points to the Word file used as a template.

8) The next code block submits the job and gets the job result:

```python
# Submit the job and gets the job result
location = pdf_services.submit(document_merge_job)
pdf_services_response = pdf_services.get_job_result(location, DocumentMergePDFResult)

# Get content from the resulting asset(s)
result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
stream_asset: StreamAsset = pdf_services.get_content(result_asset)
```

9) The next code block saves the result at the specified location:

```python
output_file_path = 'output/MergeDocumentToPDF.pdf'
with open(output_file_path, "wb") as file:
file.write(stream_asset.get_input_stream())
```

Here's the complete application (`src/documentmerge/merge_document_to_pdf.py`):

```python
import json
import logging
import os
from datetime import datetime

from adobe.pdfservices.operation.auth.service_principal_credentials import ServicePrincipalCredentials
from adobe.pdfservices.operation.exception.exceptions import ServiceApiException, ServiceUsageException, SdkException
from adobe.pdfservices.operation.io.cloud_asset import CloudAsset
from adobe.pdfservices.operation.io.stream_asset import StreamAsset
from adobe.pdfservices.operation.pdf_services import PDFServices
from adobe.pdfservices.operation.pdf_services_media_type import PDFServicesMediaType
from adobe.pdfservices.operation.pdfjobs.jobs.document_merge_job import DocumentMergeJob
from adobe.pdfservices.operation.pdfjobs.params.documentmerge.document_merge_params import DocumentMergeParams
from adobe.pdfservices.operation.pdfjobs.params.documentmerge.output_format import OutputFormat
from adobe.pdfservices.operation.pdfjobs.result.document_merge_result import DocumentMergePDFResult

# Initialize the logger
logging.basicConfig(level=logging.INFO)


#
# This sample illustrates how to merge the Word based document template with the input JSON data to generate
# the output document in the PDF format.
#
# To know more about document generation and document templates, please see the
# <a href="http://www.adobe.com/go/dcdocgen_overview_doc">documentation</a>
#
# Refer to README.md for instructions on how to run the samples.
#
class MergeDocumentToPDF:
def __init__(self):
try:
file = open('./receiptTemplate.docx', 'rb')
input_stream = file.read()
file.close()

# Initial setup, create credentials instance
credentials = ServicePrincipalCredentials(
client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
)

# Creates a PDF Services instance
pdf_services = PDFServices(credentials=credentials)

# Creates an asset(s) from source file(s) and upload
input_asset = pdf_services.upload(input_stream=input_stream,
mime_type=PDFServicesMediaType.DOCX)

# Setup input data for the document merge process
with open('./receipt.json', 'r') as file:
content_string = file.read()
json_data_for_merge = json.loads(content_string)

# Create parameters for the job
document_merge_params = DocumentMergeParams(json_data_for_merge=json_data_for_merge,
output_format=OutputFormat.PDF)

# Creates a new job instance
document_merge_job = DocumentMergeJob(input_asset=input_asset,
document_merge_params=document_merge_params)

# Submit the job and gets the job result
location = pdf_services.submit(document_merge_job)
pdf_services_response = pdf_services.get_job_result(location, DocumentMergePDFResult)

# Get content from the resulting asset(s)
result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
stream_asset: StreamAsset = pdf_services.get_content(result_asset)

# Creates an output stream and copy stream asset's content to it
output_file_path = 'output/MergeDocumentToPDF.pdf'
with open(output_file_path, "wb") as file:
file.write(stream_asset.get_input_stream())

except (ServiceApiException, ServiceUsageException, SdkException) as e:
logging.exception(f'Exception encountered while executing operation: {e}')

if __name__ == "__main__":
MergeDocumentToPDF()
```

## Next Steps

Now that you've successfully performed your first operation, [review the documentation](https://developer.adobe.com/document-services/docs/overview/pdf-services-api/) for many other examples and reach out on our [forums](https://community.adobe.com/t5/acrobat-services-api/ct-p/ct-Document-Cloud-SDK?page=1&sort=latest_replies&filter=all&lang=all&tabid=discussions&topics=label-accessibilityauto-tagapi) with any questions. Also remember the samples you downloaded while creating your credentials also have many demos.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions src/pages/overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ The [PDF Services API](pdf-services-api) offers a number of operations to progra

There are also capabilities to compress or linearize document for faster web viewing, and to insert, reorder, rotate, replace, and delete pages within documents.

The PDF Services API includes ready-to-use code samples for Java, Node.js and .NET and has a [Free Tier which includes 500 free Document Transactions per month.](https://acrobatservices.adobe.com/dc-integration-creation-app-cdn/main.html?api=pdf-services-api)
The PDF Services API includes ready-to-use code samples for Java, Node.js, Python and .NET and has a [Free Tier which includes 500 free Document Transactions per month.](https://acrobatservices.adobe.com/dc-integration-creation-app-cdn/main.html?api=pdf-services-api)

The PDF Services API is also available on [Power Automate](https://docs.microsoft.com/en-us/power-automate/) with easy to integrate Power Automate connectors.

## Document Generation API for automating document workflows

The [Document Generation API](document-generation-api) is a cloud-based web service that allows you to produce high fidelity PDF and Word documents with dynamic data inputs. Using Document Generation API, you can merge your data(e.g. JSON file) with Word templates to create dynamic documents for contracts and agreements, invoices, proposals, reports, forms, branded marketing documents and more.

Embed Document Generation API into any application using [PDFServices SDK](pdf-services-api#sdk) for Node.js, .Net, and Java. [Start with a Free Tier which includes 500 free Document Transactions per month.](https://acrobatservices.adobe.com/dc-integration-creation-app-cdn/main.html?api=document-generation-api)
Embed Document Generation API into any application using [PDFServices SDK](pdf-services-api#sdk) for Node.js, .Net, Python and Java. [Start with a Free Tier which includes 500 free Document Transactions per month.](https://acrobatservices.adobe.com/dc-integration-creation-app-cdn/main.html?api=document-generation-api)

## PDF Extract API for extracting PDF structure and information

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -593,7 +593,7 @@ After downloading the zip, you can run the samples in the zip directly by settin

#### Setup a Python environment

1. Install [Python 3.6](https://www.python.org/downloads/) or higher.
1. Install [Python 3.10](https://www.python.org/downloads/) or higher.
2. Verify your installation by running this command: `python --version`.

##### Running the samples
Expand Down Expand Up @@ -622,7 +622,7 @@ For security reasons you may wish to confirm the installer's authenticity. To do
1. After downloading the package zip, run following command

```
pip hash <download_dir>/pdfservices-sdk-2.3.1.tar.gz
pip hash <download_dir>/pdfservices-sdk-3.0.0.tar.gz
```

1. Above command will return the hash of downloaded package.
Expand Down
Loading
Loading