Dodawaj adnotacje do dokumentów PDF za pomocą Python

Możesz programowo dodawać adnotacje do dowolnego dokumentu PDF w chmurze za pomocą Python. Mogą to być dowolne dodatkowe informacje o istniejących danych w postaci zdjęć, komentarzy, notatek lub innego rodzaju zewnętrznych uwag w dokumencie. W tym artykule dowiesz się, jak dodawać adnotacje do dokumentów PDF za pomocą interfejsu API REST w Python.

W tym artykule zostaną omówione następujące tematy:

Interfejs API REST do adnotacji dokumentów i pakiet SDK języka Python

Do opisywania dokumentów PDF będę używał Python SDK of GroupDocs.Annotation Cloud API. Pozwala programowo budować narzędzia adnotacji dokumentów online. Możesz dodawać adnotacje, nakładki ze znakami wodnymi, zamienniki tekstu, redakcje i znaczniki tekstu do dokumentów biznesowych we wszystkich popularnych formatach. Udostępnia również zestawy SDK .NET, Java, PHP, Ruby i Node.js jako członkowie rodziny adnotacji dokumentów dla Cloud API.

Możesz zainstalować GroupDocs.Annotation Cloud w swoim projekcie Python za pomocą następującego polecenia w konsoli:

pip install groupdocs_annotation_cloud

Zanim zaczniesz postępować zgodnie z instrukcjami i dostępnymi przykładami kodu, uzyskaj swój identyfikator klienta i klucz tajny klienta z panelu nawigacyjnego. Po uzyskaniu identyfikatora i tajnego kodu dodaj kod, jak pokazano poniżej:

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

Dodawaj adnotacje do dokumentów PDF za pomocą interfejsu API REST w języku Python

Możesz dodawać adnotacje do swoich dokumentów PDF, wykonując proste czynności podane poniżej:

  1. Prześlij plik PDF do chmury
  2. Dodaj adnotacje do dokumentów PDF za pomocą Python
  3. Pobierz plik z adnotacjami

Prześlij dokument

Najpierw prześlij plik PDF do chmury, korzystając z następującego przykładowego kodu:

# utwórz instancję api
file_api = groupdocs_annotation_cloud.FileApi.from_config(configuration)
my_storage = ""

# prześlij przykładowy plik
request = groupdocs_annotation_cloud.UploadFileRequest("sample.pdf", "C:\\Files\\sample.pdf", my_storage)
response = file_api.upload_file(request)

W rezultacie przesłany plik PDF będzie dostępny w sekcji plików Twojego pulpitu nawigacyjnego w chmurze.

Dodawaj adnotacje do dokumentów PDF za pomocą Python

Wykonaj czynności wymienione poniżej, aby programowo dodać wiele adnotacji do dokumentu PDF.

  • Utwórz instancję AnnotateApi
  • Utwórz pierwszą instancję AnnotationInfo
  • Ustaw właściwości adnotacji dla pierwszego wystąpienia, np. pozycja, typ, tekst itp.
  • Utwórz drugą instancję AnnotationInfo
  • Ustaw właściwości adnotacji dla drugiej instancji, np. pozycja, typ, tekst itp.
  • Utwórz trzecią instancję AnnotationInfo
  • Ustaw właściwości adnotacji dla trzeciego wystąpienia, np. pozycja, typ, tekst itp.
  • Utwórz instancję FileInfo i ustaw ścieżkę pliku wejściowego
  • Utwórz instancję AnnotateOptions i ustaw informacje o pliku na AnnotateOptions
  • Przypisz pierwszą, drugą i trzecią adnotację do AnnotateOptions
  • Utwórz żądanie, wywołując metodę AnnotateRequest
  • Uzyskaj wyniki, wywołując metodę AnnotateApi.annotate().

Poniższy przykładowy kod pokazuje, jak dodawać adnotacje do dokumentu PDF i dodawać wiele adnotacji przy użyciu interfejsu API REST.

# zainicjować api
api = groupdocs_annotation_cloud.AnnotateApi.from_config(configuration)

# adnotacja odległości
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 adnotacja odległości"
a1.creator_name = "Anonym A."

# adnotacja obszaru
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 adnotacja obszaru"
a2.creator_name = "Anonym A."

# adnotacja strzałki
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 adnotacja strzałki"
a3.creator_name = "Anonym A."

# plik wejściowy
file_info = groupdocs_annotation_cloud.FileInfo()
file_info.file_path = "sample.pdf"

# zdefiniuj opcje adnotacji
options = groupdocs_annotation_cloud.AnnotateOptions()
options.file_info = file_info
options.annotations = [a1, a2, a3]
options.output_path = "output.pdf"

# utwórz żądanie adnotacji
request = groupdocs_annotation_cloud.AnnotateRequest(options)
result = api.annotate(request)         

print("AddMultipleAnnotations: Multiple Annotations added: " + result['href'])
Dodaj wiele adnotacji do dokumentu PDF za pomocą interfejsu API REST w języku Python

Dodaj wiele adnotacji do dokumentu PDF za pomocą interfejsu API REST w języku Python

Możesz przeczytać więcej o obsługiwanych typach adnotacji w sekcji dodawanie adnotacji w dokumentacji.

Pobierz plik z adnotacjami

Powyższy przykładowy kod zapisze plik PDF z adnotacjami w chmurze. Możesz go pobrać, korzystając z następującego przykładowego kodu:

# inicjalizacja API
file_api = groupdocs_annotation_cloud.FileApi.from_config(configuration)
my_storage = ""

# utwórz żądanie pobrania
request = groupdocs_annotation_cloud.DownloadFileRequest("output.pdf", my_storage)
response = file_api.download_file(request)

# Przenieś pobrany plik do katalogu roboczego
shutil.move(response, "C:\\Files\\")

Dodaj adnotacje TextField za pomocą Python

Możesz programowo dodawać adnotacje do pól tekstowych w dokumentach PDF, wykonując czynności podane poniżej:

  • Utwórz instancję AnnotateApi
  • Utwórz instancję AnnotationInfo
  • Zdefiniuj pozycję adnotacji
  • Zdefiniuj położenie, wysokość i szerokość prostokąta
  • Ustaw różne właściwości adnotacji, np. tekst, wysokość, szerokość itp.
  • Ustaw typ adnotacji jako TextField
  • Utwórz instancję FileInfo i ustaw ścieżkę pliku wejściowego
  • Utwórz instancję AnnotateOptions i ustaw informacje o pliku na AnnotateOptions
  • Przypisz adnotację do AnnotateOptions
  • Utwórz żądanie, wywołując metodę AnnotateRequest
  • Uzyskaj wyniki, wywołując metodę AnnotateApi.annotate().

Poniższy przykładowy kod pokazuje, jak dodawać adnotacje pól tekstowych w dokumencie PDF przy użyciu interfejsu API REST. Wykonaj czynności wymienione wcześniej, aby przesłać i pobrać plik.

# zainicjować api
api = groupdocs_annotation_cloud.AnnotateApi.from_config(configuration)

# podaj informacje o adnotacjach
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."

# ścieżka pliku wejściowego
file_info = groupdocs_annotation_cloud.FileInfo()
file_info.file_path = "sample.pdf"

# zdefiniuj opcje adnotacji
options = groupdocs_annotation_cloud.AnnotateOptions()
options.file_info = file_info
options.annotations = [a1]
options.output_path = "output.pdf"

# utwórz żądanie adnotacji
request = groupdocs_annotation_cloud.AnnotateRequest(options)
result = api.annotate(request)         

print("AddTextFieldAnnotation: Text Field Annotation added: " + result['href'])
Dodaj adnotacje do pól tekstowych za pomocą Python

Dodaj adnotacje do pól tekstowych za pomocą Python

Dodaj adnotacje do obrazów za pomocą Python

Możesz programowo dodawać adnotacje do obrazów w dokumentach PDF, wykonując poniższe czynności:

  • Utwórz instancję AnnotateApi
  • Utwórz instancję AnnotationInfo
  • Zdefiniuj prostokąt i ustaw jego położenie, wysokość i szerokość
  • Ustaw różne właściwości adnotacji, np. pozycję, tekst, wysokość, szerokość itp.
  • Ustaw typ adnotacji jako Obraz
  • Utwórz instancję FileInfo i ustaw ścieżkę pliku wejściowego
  • Utwórz instancję AnnotateOptions i ustaw informacje o pliku na AnnotateOptions
  • Przypisz adnotację do AnnotateOptions
  • Utwórz żądanie, wywołując metodę AnnotateRequest
  • Uzyskaj wyniki, wywołując metodę AnnotateApi.annotate().

Poniższy przykładowy kod pokazuje, jak dodawać adnotacje do obrazów w dokumencie PDF przy użyciu interfejsu API REST. Wykonaj czynności wymienione wcześniej, aby przesłać i pobrać plik.

# zainicjować api
api = groupdocs_annotation_cloud.AnnotateApi.from_config(configuration)

# zdefiniuj adnotację
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"

# ścieżka pliku wejściowego
file_info = groupdocs_annotation_cloud.FileInfo()
file_info.file_path = "sample.pdf"

# zdefiniuj adnotację options
options = groupdocs_annotation_cloud.AnnotateOptions()
options.file_info = file_info
options.annotations = [a1]
options.output_path = "output_img.pdf"

# utwórz żądanie adnotacji
request = groupdocs_annotation_cloud.AnnotateRequest(options)
result = api.annotate(request)         

print("AddImageAnnotation: Image Annotation added: " + result['href'])
Dodaj adnotacje do obrazów za pomocą Python

Dodaj adnotacje do obrazów za pomocą Python

Możesz programowo dodawać adnotacje hiperłączy w dokumentach PDF, wykonując czynności podane poniżej:

  • Utwórz instancję AnnotateApi
  • Utwórz instancję AnnotationInfo
  • Zdefiniuj punkty adnotacji i ustaw pozycję dla każdego punktu
  • Ustaw różne właściwości adnotacji, np. tekst, wysokość, szerokość itp.
  • Ustaw typ adnotacji jako Link
  • Utwórz instancję FileInfo i ustaw ścieżkę pliku wejściowego
  • Utwórz instancję AnnotateOptions i ustaw informacje o pliku na AnnotateOptions
  • Przypisz adnotację do AnnotateOptions
  • Utwórz żądanie, wywołując metodę AnnotateRequest
  • Uzyskaj wyniki, wywołując metodę AnnotateApi.annotate().

Poniższy przykładowy kod pokazuje, jak dodawać adnotacje hiperlinków w dokumencie PDF przy użyciu interfejsu API REST. Wykonaj czynności wymienione wcześniej, aby przesłać i pobrać plik.

# zainicjować api
api = groupdocs_annotation_cloud.AnnotateApi.from_config(configuration)

# podaj informacje o adnotacjach
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/"

# ścieżka pliku wejściowego
file_info = groupdocs_annotation_cloud.FileInfo()
file_info.file_path = "sample.pdf"

# zdefiniuj opcje adnotacji
options = groupdocs_annotation_cloud.AnnotateOptions()
options.file_info = file_info
options.annotations = [a1]
options.output_path = "output.pdf"

# utwórz żądanie adnotacji
request = groupdocs_annotation_cloud.AnnotateRequest(options)
result = api.annotate(request)         

print("AddLinkAnnotation: Link Annotation added: " + result['href'])
Dodawaj adnotacje za pomocą adnotacji linków przy użyciu języka Python

Dodawaj adnotacje za pomocą adnotacji linków przy użyciu języka Python

Wypróbuj online

Wypróbuj następujące bezpłatne narzędzie online do adnotacji PDF, które zostało opracowane przy użyciu powyższego interfejsu API. https://products.groupdocs.app/annotation/pdf

Wniosek

W tym artykule nauczyłeś się dodawać różne rodzaje adnotacji do dokumentów PDF w chmurze. Ponadto nauczyłeś się, jak programowo przesłać plik PDF do chmury, a następnie pobrać plik z adnotacjami z chmury. Możesz dowiedzieć się więcej o GroupDocs.Annotation Cloud API, korzystając z dokumentacji. Udostępniamy również sekcję Informacje o interfejsach API, która umożliwia wizualizację i interakcję z naszymi interfejsami API bezpośrednio w przeglądarce. W przypadku jakichkolwiek niejasności prosimy o kontakt na forum.

Zobacz też