Mit Python können Sie jedes PDF Dokument programmgesteuert in der Cloud mit Anmerkungen versehen. Dabei kann es sich um beliebige zusätzliche Informationen zu einem vorhandenen Datenelement in Form von Bildern, Kommentaren, Notizen oder anderen Arten von externen Anmerkungen im Dokument handeln. In diesem Artikel erfahren Sie, wie Sie PDF Dokumente mithilfe einer REST-API in Python mit Anmerkungen versehen.
Die folgenden Themen sollen in diesem Artikel behandelt werden:
- Document Annotation REST API und Python SDK
- Kommentieren Sie PDF Dokumente mithilfe einer REST-API in Python
- Fügen Sie TextField-Anmerkungen mit Python hinzu
- Fügen Sie Bildanmerkungen mit Python hinzu
- Kommentieren Sie mit Link-Annotationen mit Python
Document Annotation REST API und Python SDK
Zum Kommentieren von PDF Dokumenten verwende ich das Python SDK der GroupDocs.Annotation Cloud API. Es ermöglicht die programmgesteuerte Online-Erstellung von Dokumentanmerkungstools. Sie können den Geschäftsdokumenten aller gängigen Formate Anmerkungen, Wasserzeichenüberlagerungen, Textersetzungen, Schwärzungen und Textmarkierungen hinzufügen. Es stellt außerdem .NET-, Java-, PHP-, Ruby und Node.js-SDKs als Mitglieder der Dokumentanmerkungsfamilie für die Cloud-API bereit.
Sie können GroupDocs.Annotation Cloud mit dem folgenden Befehl in der Konsole in Ihrem Python-Projekt installieren:
pip install groupdocs_annotation_cloud
Bitte rufen Sie Ihre Client-ID und Ihr Client-Geheimnis vom Dashboard ab, bevor Sie mit dem Befolgen der Schritte und verfügbaren Codebeispiele beginnen. Sobald Sie Ihre ID und Ihr Geheimnis haben, fügen Sie den Code wie unten gezeigt ein:
client_id = "659fe7da-715b-4744-a0f7-cf469a392b73"
client_secret = "b377c36cfa28fa69960ebac6b6e36421"
configuration = groupdocs_annotation_cloud.Configuration(client_id, client_secret)
configuration.api_base_url = "https://api.groupdocs.cloud"
my_storage = ""
Kommentieren Sie PDF Dokumente mithilfe einer REST-API in Python
Sie können Ihren PDF Dokumenten Anmerkungen hinzufügen, indem Sie die folgenden einfachen Schritte ausführen:
- Hochladen der PDF-Datei in die Cloud
- PDF Dokumente mit Python kommentieren
- Herunterladen der kommentierten Datei
Laden Sie das Dokument hoch
Laden Sie zunächst die PDF-Datei mit dem folgenden Codebeispiel in die Cloud hoch:
# Erstellen Sie eine Instanz der API
file_api = groupdocs_annotation_cloud.FileApi.from_config(configuration)
my_storage = ""
# Beispieldatei hochladen
request = groupdocs_annotation_cloud.UploadFileRequest("sample.pdf", "C:\\Files\\sample.pdf", my_storage)
response = file_api.upload_file(request)
Dadurch ist die hochgeladene PDF-Datei im Dateienbereich Ihres Dashboards in der Cloud verfügbar.
Kommentieren Sie PDF Dokumente mit Python
Bitte befolgen Sie die unten aufgeführten Schritte, um dem PDF Dokument programmgesteuert mehrere Anmerkungen hinzuzufügen.
- Erstellen Sie eine Instanz von AnnotateApi
- Erstellen Sie die erste Instanz von AnnotationInfo
- Legen Sie Anmerkungseigenschaften für die erste Instanz fest, z. B. Position, Typ, Text usw.
- Erstellen Sie eine zweite AnnotationInfo-Instanz
- Legen Sie Anmerkungseigenschaften für die zweite Instanz fest, z. B. Position, Typ, Text usw.
- Erstellen Sie eine dritte AnnotationInfo-Instanz
- Legen Sie Anmerkungseigenschaften für die dritte Instanz fest, z. B. Position, Typ, Text usw.
- Erstellen Sie eine FileInfo-Instanz und legen Sie den Eingabedateipfad fest
- Erstellen Sie eine Instanz von AnnotateOptions und legen Sie die Dateiinformationen auf AnnotateOptions fest
- Weisen Sie AnnotateOptions die erste, zweite und dritte Anmerkung zu
- Erstellen Sie eine Anfrage, indem Sie die AnnotateRequest-Methode aufrufen
- Erhalten Sie Ergebnisse, indem Sie die Methode AnnotateApi.annotate() aufrufen
Das folgende Codebeispiel zeigt, wie Sie ein PDF Dokument mit Anmerkungen versehen und mithilfe einer REST-API mehrere Anmerkungen hinzufügen.
# API initialisieren
api = groupdocs_annotation_cloud.AnnotateApi.from_config(configuration)
# Abstandsanmerkung
a1 = groupdocs_annotation_cloud.AnnotationInfo()
a1.annotation_position = groupdocs_annotation_cloud.Point()
a1.annotation_position.x = 1
a1.annotation_position.y = 1
a1.box = groupdocs_annotation_cloud.Rectangle()
a1.box.x = 100
a1.box.y = 100
a1.box.width = 200
a1.box.height = 200
a1.page_number = 0
a1.pen_color = 1201033
a1.pen_style = "Solid"
a1.pen_width = 3
a1.opacity = 1
a1.type = "Distance"
a1.text = "This is Abstandsanmerkung"
a1.creator_name = "Anonym A."
# Bereichsanmerkung
a2 = groupdocs_annotation_cloud.AnnotationInfo()
a2.annotation_position = groupdocs_annotation_cloud.Point()
a2.annotation_position.x = 1
a2.annotation_position.y = 1
a2.box = groupdocs_annotation_cloud.Rectangle()
a2.box.x = 100
a2.box.y = 400
a2.box.width = 200
a2.box.height = 100
a2.page_number = 0
a2.pen_color = 1201033
a2.pen_style = "Solid"
a2.pen_width = 3
a2.opacity = 1
a2.type = "Area"
a2.text = "This is Bereichsanmerkung"
a2.creator_name = "Anonym A."
# Pfeilanmerkung
a3 = groupdocs_annotation_cloud.AnnotationInfo()
a3.annotation_position = groupdocs_annotation_cloud.Point()
a3.annotation_position.x = 1
a3.annotation_position.y = 1
a3.box = groupdocs_annotation_cloud.Rectangle()
a3.box.x = 100
a3.box.y = 250
a3.box.width = 100
a3.box.height = 50
a3.page_number = 0
a3.pen_color = 1201033
a3.pen_style = "Solid"
a3.pen_width = 1
a3.opacity = 0.7
a3.type = "Arrow"
a3.text = "This is Pfeilanmerkung"
a3.creator_name = "Anonym A."
# Eingabedatei
file_info = groupdocs_annotation_cloud.FileInfo()
file_info.file_path = "sample.pdf"
# Anmerkungsoptionen definieren
options = groupdocs_annotation_cloud.AnnotateOptions()
options.file_info = file_info
options.annotations = [a1, a2, a3]
options.output_path = "output.pdf"
# Anmerkungsanfrage erstellen
request = groupdocs_annotation_cloud.AnnotateRequest(options)
result = api.annotate(request)
print("AddMultipleAnnotations: Multiple Annotations added: " + result['href'])
Fügen Sie mithilfe einer REST-API in Python mehrere Anmerkungen zu einem PDF Dokument hinzu
Weitere Informationen zu den unterstützten Anmerkungstypen finden Sie im Abschnitt Anmerkungen hinzufügen in der Dokumentation.
Laden Sie die kommentierte Datei herunter
Das obige Codebeispiel speichert die kommentierte PDF-Datei in der Cloud. Sie können es mit dem folgenden Codebeispiel herunterladen:
# API-Initialisierung
file_api = groupdocs_annotation_cloud.FileApi.from_config(configuration)
my_storage = ""
# Download-Anfrage erstellen
request = groupdocs_annotation_cloud.DownloadFileRequest("output.pdf", my_storage)
response = file_api.download_file(request)
# Verschieben Sie die heruntergeladene Datei in Ihr Arbeitsverzeichnis
shutil.move(response, "C:\\Files\\")
Fügen Sie TextField-Anmerkungen mit Python hinzu
Sie können den PDF Dokumenten programmgesteuert Textfeldanmerkungen hinzufügen, indem Sie die folgenden Schritte ausführen:
- Erstellen Sie eine Instanz von AnnotateApi
- Erstellen Sie eine Instanz von AnnotationInfo
- Anmerkungsposition definieren
- Definieren Sie Position, Höhe und Breite des Rechtecks
- Legen Sie verschiedene Anmerkungseigenschaften fest, z. B. Text, Höhe, Breite usw.
- Legen Sie den Anmerkungstyp als TextField fest
- Erstellen Sie eine FileInfo-Instanz und legen Sie den Eingabedateipfad fest
- Erstellen Sie eine Instanz von AnnotateOptions und legen Sie die Dateiinformationen auf AnnotateOptions fest
- Weisen Sie AnnotateOptions eine Anmerkung zu
- Erstellen Sie eine Anfrage, indem Sie die AnnotateRequest-Methode aufrufen
- Erhalten Sie Ergebnisse, indem Sie die Methode AnnotateApi.annotate() aufrufen
Das folgende Codebeispiel zeigt, wie Sie mithilfe einer REST-API Textfeldanmerkungen zum PDF Dokument hinzufügen. Bitte befolgen Sie die zuvor genannten Schritte, um eine Datei hoch und herunterzuladen.
# API initialisieren
api = groupdocs_annotation_cloud.AnnotateApi.from_config(configuration)
# Anmerkungsinformationen bereitstellen
a1 = groupdocs_annotation_cloud.AnnotationInfo()
a1.annotation_position = groupdocs_annotation_cloud.Point()
a1.annotation_position.x = 1
a1.annotation_position.y = 1
a1.box = groupdocs_annotation_cloud.Rectangle()
a1.box.x = 380
a1.box.y = 300
a1.box.width = 100
a1.box.height = 50
a1.page_number = 0
a1.font_color = 1201033
a1.font_size = 12
a1.opacity = 0.7
a1.type = "TextField"
a1.text = "Text field text"
a1.creator_name = "Anonym A."
# Eingabedateipfad
file_info = groupdocs_annotation_cloud.FileInfo()
file_info.file_path = "sample.pdf"
# Anmerkungsoptionen definieren
options = groupdocs_annotation_cloud.AnnotateOptions()
options.file_info = file_info
options.annotations = [a1]
options.output_path = "output.pdf"
# Anmerkungsanfrage erstellen
request = groupdocs_annotation_cloud.AnnotateRequest(options)
result = api.annotate(request)
print("AddTextFieldAnnotation: Text Field Annotation added: " + result['href'])
Fügen Sie Textfeldanmerkungen mit Python hinzu
Fügen Sie Bildanmerkungen mit Python hinzu
Sie können Ihren PDF Dokumenten Bildanmerkungen programmgesteuert hinzufügen, indem Sie die folgenden Schritte ausführen:
- Erstellen Sie eine Instanz von AnnotateApi
- Erstellen Sie eine Instanz von AnnotationInfo
- Definieren Sie ein Rechteck und legen Sie dessen Position, Höhe und Breite fest
- Legen Sie verschiedene Anmerkungseigenschaften fest, z. B. Position, Text, Höhe, Breite usw.
- Legen Sie den Anmerkungstyp als Bild fest
- Erstellen Sie eine FileInfo-Instanz und legen Sie den Eingabedateipfad fest
- Erstellen Sie eine Instanz von AnnotateOptions und legen Sie die Dateiinformationen auf AnnotateOptions fest
- Weisen Sie AnnotateOptions eine Anmerkung zu
- Erstellen Sie eine Anfrage, indem Sie die AnnotateRequest-Methode aufrufen
- Erhalten Sie Ergebnisse, indem Sie die Methode AnnotateApi.annotate() aufrufen
Das folgende Codebeispiel zeigt, wie Sie mithilfe einer REST-API Bildanmerkungen zum PDF Dokument hinzufügen. Bitte befolgen Sie die zuvor genannten Schritte, um eine Datei hoch und herunterzuladen.
# API initialisieren
api = groupdocs_annotation_cloud.AnnotateApi.from_config(configuration)
# Anmerkung definieren
a1 = groupdocs_annotation_cloud.AnnotationInfo()
a1.box = groupdocs_annotation_cloud.Rectangle()
a1.box.x = 300
a1.box.y = 300
a1.box.width = 200
a1.box.height = 100
a1.page_number = 0
a1.pen_color = 1201033
a1.pen_style = "Solid"
a1.pen_width = 1
a1.opacity = 0.7
a1.type = "Image"
a1.text = "This is Image annotation"
a1.creator_name = "Anonym A."
a1.image_path = "JohnSmith.png"
# Eingabedateipfad
file_info = groupdocs_annotation_cloud.FileInfo()
file_info.file_path = "sample.pdf"
# Anmerkung definieren options
options = groupdocs_annotation_cloud.AnnotateOptions()
options.file_info = file_info
options.annotations = [a1]
options.output_path = "output_img.pdf"
# Anmerkungsanfrage erstellen
request = groupdocs_annotation_cloud.AnnotateRequest(options)
result = api.annotate(request)
print("AddImageAnnotation: Image Annotation added: " + result['href'])
Fügen Sie Bildanmerkungen mit Python hinzu
Kommentieren Sie mit Link-Annotationen mit Python
Sie können den PDF Dokumenten programmgesteuert Hyperlink-Anmerkungen hinzufügen, indem Sie die folgenden Schritte ausführen:
- Erstellen Sie eine Instanz von AnnotateApi
- Erstellen Sie eine Instanz von AnnotationInfo
- Definieren Sie Anmerkungspunkte und legen Sie die Position für jeden Punkt fest
- Legen Sie verschiedene Anmerkungseigenschaften fest, z. B. Text, Höhe, Breite usw.
- Legen Sie den Anmerkungstyp als Link fest
- Erstellen Sie eine FileInfo-Instanz und legen Sie den Eingabedateipfad fest
- Erstellen Sie eine Instanz von AnnotateOptions und legen Sie die Dateiinformationen auf AnnotateOptions fest
- Weisen Sie AnnotateOptions eine Anmerkung zu
- Erstellen Sie eine Anfrage, indem Sie die AnnotateRequest-Methode aufrufen
- Erhalten Sie Ergebnisse, indem Sie die Methode AnnotateApi.annotate() aufrufen
Das folgende Codebeispiel zeigt, wie Sie mithilfe einer REST-API Hyperlink-Anmerkungen zum PDF Dokument hinzufügen. Bitte befolgen Sie die zuvor genannten Schritte, um eine Datei hoch und herunterzuladen.
# API initialisieren
api = groupdocs_annotation_cloud.AnnotateApi.from_config(configuration)
# Anmerkungsinformationen bereitstellen
a1 = groupdocs_annotation_cloud.AnnotationInfo()
p1 = groupdocs_annotation_cloud.Point()
p1.x = 80
p1.y = 710
p2 = groupdocs_annotation_cloud.Point()
p2.x = 240
p2.y = 710
p3 = groupdocs_annotation_cloud.Point()
p3.x = 80
p3.y = 650
p4 = groupdocs_annotation_cloud.Point()
p4.x = 240
p4.y = 650
a1.points = [p1, p2, p3, p4]
a1.page_number = 0
a1.type = "Link"
a1.text = "This is Link annotation"
a1.creator_name = "Anonym A."
a1.url = "https://www.groupdocs.com/"
# Eingabedateipfad
file_info = groupdocs_annotation_cloud.FileInfo()
file_info.file_path = "sample.pdf"
# Anmerkungsoptionen definieren
options = groupdocs_annotation_cloud.AnnotateOptions()
options.file_info = file_info
options.annotations = [a1]
options.output_path = "output.pdf"
# Anmerkungsanfrage erstellen
request = groupdocs_annotation_cloud.AnnotateRequest(options)
result = api.annotate(request)
print("AddLinkAnnotation: Link Annotation added: " + result['href'])
Kommentieren Sie mit Link-Annotationen mit Python
Versuchen Sie es online
Bitte probieren Sie das folgende kostenlose Online-PDF-Anmerkungstool aus, das mit der oben genannten API entwickelt wurde. https://products.groupdocs.app/annotation/pdf
Abschluss
In diesem Artikel haben Sie erfahren, wie Sie PDF Dokumenten in der Cloud verschiedene Arten von Anmerkungen hinzufügen. Darüber hinaus haben Sie gelernt, wie Sie die PDF-Datei programmgesteuert in die Cloud hochladen und dann die kommentierte Datei aus der Cloud herunterladen. Weitere Informationen zur GroupDocs.Annotation Cloud API finden Sie in der Dokumentation. Wir bieten auch einen Abschnitt API-Referenz an, mit dem Sie unsere APIs direkt über den Browser visualisieren und mit ihnen interagieren können. Bei Unklarheiten können Sie uns gerne im Forum kontaktieren.