How to add Links to PDF via Cloud Python SDK
To add links into PDF, we’ll use Aspose.PDF Cloud Python SDK. This Cloud SDK assists Python programmers in developing cloud-based PDF creator, annotator, editor, and converter apps using Python programming language via Aspose.PDF REST API. Simply create an account at Aspose for Cloud and get your application information. Once you have the App SID & key, you are ready to give the Aspose.PDF Cloud Python SDK. If the python package is hosted on Github, you can install directly from Github:
Installation from Github
pip install git+https://github.com/aspose-pdf-cloud/aspose-pdf-cloud-python.git
Package Manager Console Command
pip install asposepdfcloud
Steps to add Links into PDF via Python SDK
Aspose.PDF Cloud developers can easily load & add links to PDF in just a few lines of code.
- Install Python SDK
- Upload a PDF document to the Aspose Cloud server
- Download the processed PDF document from the Aspose Cloud server
- Append a new hyperlink annotation to a specific page in the PDF document
Add Links to PDF using Python
import shutil
import json
import logging
from pathlib import Path
from asposepdfcloud import ApiClient, PdfApi, LinkAnnotation, LinkActionType, LinkHighlightingMode, Color, Link, Rectangle
# Configure logging
logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s")
class Config:
"""Configuration parameters."""
CREDENTIALS_FILE = Path(r"..\\credentials.json")
LOCAL_FOLDER = Path(r"C:\Samples")
PDF_DOCUMENT_NAME = "sample.pdf"
LOCAL_RESULT_DOCUMENT_NAME = "output_sample.pdf"
NEW_LINK_ACTION = "https://reference.aspose.cloud/pdf/"
PAGE_NUMBER = 2
LINK_RECT = Rectangle(llx=244.914, lly=488.622, urx=284.776, ury=498.588)
class PdfLinks:
"""Class for managing PDF links using Aspose PDF Cloud API."""
def __init__(self, credentials_file: Path = Config.CREDENTIALS_FILE):
self.pdf_api = None
self._init_api(credentials_file)
def _init_api(self, credentials_file: Path):
"""Initialize the API client."""
try:
with credentials_file.open("r", encoding="utf-8") as file:
credentials = json.load(file)
api_key, app_id = credentials.get("key"), credentials.get("id")
if not api_key or not app_id:
raise ValueError("init_api(): Error: Missing API keys in the credentials file.")
self.pdf_api = PdfApi(ApiClient(api_key, app_id))
except (FileNotFoundError, json.JSONDecodeError, ValueError) as e:
logging.error(f"init_api(): Failed to load credentials: {e}")
def upload_document(self):
"""Upload a PDF document to the Aspose Cloud server."""
if self.pdf_api:
file_path = Config.LOCAL_FOLDER / Config.PDF_DOCUMENT_NAME
try:
self.pdf_api.upload_file(Config.PDF_DOCUMENT_NAME, str(file_path))
logging.info(f"upload_document(): File {Config.PDF_DOCUMENT_NAME} uploaded successfully.")
except Exception as e:
logging.error(f"upload_document(): Failed to upload file: {e}")
def download_result(self):
"""Download the processed PDF document from the Aspose Cloud server."""
if self.pdf_api:
try:
temp_file = self.pdf_api.download_file(Config.PDF_DOCUMENT_NAME)
local_path = Config.LOCAL_FOLDER / Config.LOCAL_RESULT_DOCUMENT_NAME
shutil.move(temp_file, str(local_path))
logging.info(f"download_result(): File successfully downloaded: {local_path}")
except Exception as e:
logging.error(f"download_result(): Failed to download file: {e}")
def append_link(self):
"""Append a new hyperlink annotation to a specific page in the PDF document."""
if self.pdf_api:
link_annotation = LinkAnnotation(
links=[Link(href=Config.NEW_LINK_ACTION)],
action_type= LinkActionType.GOTOURIACTION,
action=Config.NEW_LINK_ACTION,
highlighting=LinkHighlightingMode.INVERT,
color=Color(a=255, r=0, g=255, b=0),
rect=Config.LINK_RECT,
)
try:
response = self.pdf_api.post_page_link_annotations(
Config.PDF_DOCUMENT_NAME, Config.PAGE_NUMBER, [link_annotation]
)
if response.code == 200:
logging.info(f"append_link(): Link '{Config.NEW_LINK_ACTION}' added to page #{Config.PAGE_NUMBER}.")
else:
logging.error(f"append_link(): Failed to add link to the page. Response code: {response.code}")
except Exception as e:
logging.error(f"append_link(): Error while adding link: {e}")
if __name__ == "__main__":
pdf_links = PdfLinks()
pdf_links.upload_document()
pdf_links.append_link()
pdf_links.download_result()
Work with the Links in PDF via Python SDK
Adding links to a PDF enhances usability, interactivity, and accessibility. Whether for navigation, marketing, or cross-referencing, hyperlinks improve the document’s effectiveness, making it easier for users to find relevant content and take action. Add the Links into PDF documents with Aspose.PDF Cloud Python SDK.
With our Python SDK you can
- Add PDF document’s header & footer in text or image format.
- Add tables & text or image stamps to PDF documents.
- Append multiple PDF documents to an existing file.
- Work with PDF attachments, annotations, & form fields.
- Apply encryption or decryption to PDF documents & set a password.
- Delete all stamps & tables from a page or entire PDF document.
- Delete a specific stamp or table from the PDF document by its ID.
- Replace single or multiple instances of text on a PDF page or from the entire document.
- Extensive support for converting PDF documents to various other file formats.
- Extract various elements of PDF files & make PDF documents optimized.
- You can try out our free App to test the functionality online.
- Learning Resources
- Documentation
- Source Code
- API References
- Product Support
- Free Support
- Paid Support
- Blog
- Why Aspose.PDF Cloud for Python?
- Customers List
- Security