Kommentieren Sie PDF Dokumente mithilfe der REST-API in PHP

Anmerkungen liefern zusätzliche Informationen zu einem bestimmten Teil des Dokuments. Mithilfe von Anmerkungen können wir die Dokumente mit Feedback und Rezensionen auszeichnen. Wir können Bilder, Kommentare, Notizen oder andere Arten von externen Anmerkungen als Anmerkungen zu PDF Dokumenten hinzufügen. In diesem Artikel erfahren Sie, wie Sie PDF Dokumente mithilfe einer REST-API in PHP mit Anmerkungen versehen.

Die folgenden Themen sollen in diesem Artikel behandelt werden:

PDF Annotation REST API und PHP SDK
Kommentieren Sie PDF Dokumente mithilfe einer REST-API in PHP
Kommentieren Sie mit Link Annotation mit PHP
Bildanmerkung mit PHP hinzufügen
Fügen Sie Textfeldanmerkungen mit PHP hinzu

PDF Annotation REST API und PHP SDK

Zum Kommentieren von PDF Dokumenten verwenden wir die PHP SDK of GroupDocs.Annotation Cloud API. Es ermöglicht das Hinzufügen von Anmerkungen, Wasserzeichenüberlagerungen, Textersetzungen, Schwärzungen und Textmarkierungen zu den unterstützten Dokumentformaten. Bitte installieren Sie es mit dem folgenden Befehl in der Konsole:

composer require groupdocscloud/groupdocs-annotation-cloud

Nach der Installation verwenden Sie bitte autoload von Composers, um das SDK wie unten gezeigt zu verwenden:

require_once('vendor/autoload.php');

Bitte holen Sie sich Ihre Kunden-ID und Ihr Geheimnis aus dem Dashboard, bevor Sie die genannten Schritte ausführen. Sobald Sie Ihre ID und Ihr Geheimnis haben, fügen Sie den Code wie unten gezeigt ein:

// Dieses Codebeispiel zeigt, wie man die Client-ID und das Geheimnis zum Code hinzufügt.
static $ClientId = '659fe7da-715b-4744-a0f7-cf469a392b73';
static $ClientSecret = 'b377c36cfa28fa69960ebac6b6e36421';

static $ApiBaseUrl = 'https://api.groupdocs.cloud';
static $MyStorage = '';

// Initialisierung der Konfiguration
$configuration = new GroupDocs\Annotation\Configuration();

// Festlegen der Konfigurationen
$configuration->setAppSid(self::$ClientId);
$configuration->setAppKey(self::$ClientSecret);
$configuration->setApiBaseUrl(self::$ApiBaseUrl);

Kommentieren Sie PDF Dokumente mithilfe einer REST-API in PHP

Wir können PDF Dokumente in der Cloud mit Anmerkungen versehen, indem wir die folgenden einfachen Schritte ausführen:

Hochladen der PDF-Datei in die Cloud
PDF Dokument mit Anmerkungen versehen
Herunterladen der kommentierten Datei

Laden Sie das Dokument hoch

Zunächst laden wir die PDF-Datei mit dem folgenden Codebeispiel in die Cloud hoch:

// Dieses Codebeispiel zeigt, wie eine PDF-Datei in die Cloud hochgeladen wird.
// Initialisieren Sie eine Instanz der API
$apiInstance = new GroupDocs\Annotation\FileApi($configuration);

// Dateipfad
$file = "C:\\Files\\Annotation\\sample.pdf";

// Erstellen Sie eine Anfrage zum Hochladen einer Datei
$request = new GroupDocs\Annotation\Model\Requests\UploadFileRequest("sample.pdf", $file, self::$MyStorage, null);

// Datei hochladen
$response = $apiInstance->uploadFile($request);

Dadurch ist die hochgeladene PDF-Datei im Dateienbereich des Dashboards in der Cloud verfügbar.

Kommentieren Sie PDF Dokumente mit PHP

Jetzt fügen wir dem hochgeladenen PDF Dokument programmgesteuert mehrere Anmerkungen hinzu, indem wir die folgenden Schritte ausführen:

Erstellen Sie zunächst eine Instanz der AnnotateApi.
Als nächstes legen Sie die Anmerkungseigenschaften fest, z. B. Position, Typ, Text usw.
Wiederholen Sie dann den obigen Schritt, um mehrere Anmerkungen hinzuzufügen.
Geben Sie als Nächstes den Eingabedateipfad an.
Initialisieren Sie dann das AnnotateOptions Objekt und legen Sie den Pfad der Ausgabedatei fest.
Erstellen Sie anschließend AnnotateRequest mit AnnotateOptions als Argument.
Kommentieren Sie abschließend PDF mit der Methode AnnotateApi.annotate().

Das folgende Codebeispiel zeigt, wie Sie mithilfe einer REST-API in PHP mehrere Anmerkungen zu einem PDF Dokument hinzufügen.

// Dieses Codebeispiel zeigt, wie Sie dem PDF mehrere Anmerkungen hinzufügen.
// AnnotationAPI-Instanz initialisieren
$apiInstance = new GroupDocs\Annotation\KommentierenApi($configuration);

// Abstandsanmerkung hinzufügen
$a = new GroupDocs\Annotation\Model\AnnotationInfo();
$pt = new GroupDocs\Annotation\Model\Point();
$pt->setX(1);
$pt->setY(1);
$a->setAnnotationPosition($pt);
$box = new GroupDocs\Annotation\Model\Rectangle();
$box->setX(100);
$box->setY(100);
$box->setWidth(200);
$box->setHeight(100);
$a->setBox($box);
$a->setPageNumber(0);
$a->setPenColor(1201033);
$a->setPenStyle(GroupDocs\Annotation\Model\AnnotationInfo::PEN_STYLE_SOLID);
$a->setPenWidth(1);
$a->setOpacity(0.7);
$a->setType(GroupDocs\Annotation\Model\AnnotationInfo::TYPE_DISTANCE);
$a->setText("This is distance annotation");
$a->setCreatorName("Anonym A.");  

// Bereichsanmerkung hinzufügen
$a1 = new GroupDocs\Annotation\Model\AnnotationInfo();
$pt1 = new GroupDocs\Annotation\Model\Point();
$pt1->setX(1);
$pt1->setY(1);
$a1->setAnnotationPosition($pt1);
$box1 = new GroupDocs\Annotation\Model\Rectangle();
$box1->setX(80);
$box1->setY(400);
$box1->setWidth(200);
$box1->setHeight(100);
$a1->setBox($box1);
$a1->setPageNumber(0);
$a1->setPenColor(1201033);
$a1->setPenStyle(GroupDocs\Annotation\Model\AnnotationInfo::PEN_STYLE_SOLID);
$a1->setPenWidth(1);
$a1->setOpacity(0.7);
$a1->setType(GroupDocs\Annotation\Model\AnnotationInfo::TYPE_AREA);
$a1->setText("This is area annotation");
$a1->setCreatorName("Anonym A.");   

// Punktanmerkung hinzufügen
$a2 = new GroupDocs\Annotation\Model\AnnotationInfo();
$pt2 = new GroupDocs\Annotation\Model\Point();
$pt2->setX(100);
$pt2->setY(100);
$a2->setAnnotationPosition($pt2);
$box2 = new GroupDocs\Annotation\Model\Rectangle();
$box2->setX(450);
$box2->setY(150);
$box2->setWidth(100);
$box2->setHeight(30);
$a2->setBox($box2);
$a2->setPageNumber(0);
$a2->setOpacity(0.7);
$a2->setType(GroupDocs\Annotation\Model\AnnotationInfo::TYPE_POINT);
$a2->setText("This is point annotation");
$a2->setCreatorName("Anonym A.");  

// Pfeilanmerkung hinzufügen
$a3 = new GroupDocs\Annotation\Model\AnnotationInfo();
$pt3 = new GroupDocs\Annotation\Model\Point();
$pt3->setX(1);
$pt3->setY(1);
$a3->setAnnotationPosition($pt3);
$box3 = new GroupDocs\Annotation\Model\Rectangle();
$box3->setX(350);
$box3->setY(350);
$box3->setWidth(200);
$box3->setHeight(100);
$a3->setBox($box3);
$a3->setPageNumber(0);
$a3->setPenColor(1201033);
$a3->setPenStyle(GroupDocs\Annotation\Model\AnnotationInfo::PEN_STYLE_SOLID);
$a3->setPenWidth(1);
$a3->setOpacity(0.7);
$a3->setType(GroupDocs\Annotation\Model\AnnotationInfo::TYPE_ARROW);
$a3->setText("This is arrow annotation");
$a3->setCreatorName("Anonym A.");  

// Pfad der Eingabedatei
$fileInfo = new GroupDocs\Annotation\Model\FileInfo();
$fileInfo->setFilePath("sample.pdf");

// Definieren Sie Anmerkungsoptionen
$options = new GroupDocs\Annotation\Model\KommentierenOptions();
$options->setFileInfo($fileInfo);
$options->setAnnotations([$a, $a1, $a2, $a3]);
$options->setOutputPath("MultipleAnnotation.pdf");

// Kommentierungsanfrage erstellen
$request = new GroupDocs\Annotation\Model\Requests\annotateRequest($options);

// Kommentieren
$result = $apiInstance->annotate($request);
echo "AddMultipleAnnotations: Multiple Annotations added: " . $result->getHref();

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. Es kann mit dem folgenden Codebeispiel heruntergeladen werden:

// Dieses Codebeispiel zeigt, wie Sie eine PDF-Datei aus der Cloud herunterladen.
// Initialisieren einer Instanz der API
$apiInstance = new GroupDocs\Annotation\FileApi($configuration);

// Erstellen Sie eine Download-Dateianfrage
$request = new GroupDocs\Annotation\Model\Requests\DownloadFileRequest("MultipleAnnotation.pdf", self::$MyStorage, null);

// Download-Datei
$response = $apiInstance->downloadFile($request);

Kommentieren Sie mit Link Annotation mit PHP

Wir können dem PDF Dokument auch Hyperlink-Anmerkungen hinzufügen, indem wir die folgenden Schritte ausführen:

Erstellen Sie zunächst eine Instanz der AnnotateApi.
Als nächstes legen Sie die Anmerkungseigenschaften fest, z. B. Position, Text usw.
Legen Sie dann den Anmerkungstyp auf „Link“ fest.
Geben Sie als Nächstes den Eingabedateipfad an.
Initialisieren Sie dann das AnnotateOptions Objekt und legen Sie den Pfad der Ausgabedatei fest.
Erstellen Sie anschließend AnnotateRequest mit AnnotateOptions als Argument.
Kommentieren Sie abschließend PDF mit der Methode AnnotateApi.annotate().

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.

// Dieses Codebeispiel zeigt, wie man Linkanmerkungen zu PDF hinzufügt
// AnnotationAPI-Instanz initialisieren
$apiInstance = new GroupDocs\Annotation\KommentierenApi($configuration);

// Linkanmerkung hinzufügen
$a = new GroupDocs\Annotation\Model\AnnotationInfo();
$pt1 = new GroupDocs\Annotation\Model\Point();
$pt1->setX(80);
$pt1->setY(710);
$pt2 = new GroupDocs\Annotation\Model\Point();
$pt2->setX(240);
$pt2->setY(710);		
$pt3 = new GroupDocs\Annotation\Model\Point();
$pt3->setX(80);
$pt3->setY(650);		
$pt4 = new GroupDocs\Annotation\Model\Point();
$pt4->setX(240);
$pt4->setY(650);		
$a->setPoints([$pt1, $pt2, $pt3, $pt4]);
$a->setUrl("https://www.groupdocs.com/");
$a->setPageNumber(0);
$a->setFontColor(1201033);
$a->setType(GroupDocs\Annotation\Model\AnnotationInfo::TYPE_LINK);
$a->setText("This is link annotation");
$a->setCreatorName("Anonym A.");   

// Pfad der Eingabedatei
$fileInfo = new GroupDocs\Annotation\Model\FileInfo();
$fileInfo->setFilePath("sample.pdf");

// Definieren Sie Anmerkungsoptionen
$options = new GroupDocs\Annotation\Model\KommentierenOptions();
$options->setFileInfo($fileInfo);
$options->setAnnotations([$a]);
$options->setOutputPath("AddLinkAnnotation.pdf");

// Kommentierungsanfrage erstellen
$request = new GroupDocs\Annotation\Model\Requests\annotateRequest($options);

// Kommentieren
$result = $apiInstance->annotate($request);
echo "AddLinkAnnotation: Link Annotation added: " . $result->getHref();

Kommentieren Sie mit Link-Annotationen mit PHP.

Fügen Sie Bildanmerkungen mit PHP hinzu

Wir können dem PDF Dokument Bildanmerkungen hinzufügen, indem wir die zuvor genannten Schritte ausführen. Wir müssen jedoch nur den Anmerkungstyp auf „Bild“ setzen, wie unten gezeigt:

$a->setType(GroupDocs\Annotation\Model\AnnotationInfo::TYPE_IMAGE);

Das folgende Codebeispiel zeigt, wie Sie mithilfe einer REST-API in PHP Bildanmerkungen zum PDF Dokument hinzufügen. Bitte befolgen Sie die zuvor genannten Schritte, um eine Datei hoch und herunterzuladen.

// Dieses Codebeispiel zeigt, wie man Bildanmerkungen zu PDF hinzufügt
// AnnotationAPI-Instanz initialisieren
$apiInstance = new GroupDocs\Annotation\KommentierenApi($configuration);

// Bildanmerkung hinzufügen
$a = new GroupDocs\Annotation\Model\AnnotationInfo();
$pt = new GroupDocs\Annotation\Model\Point();
$pt->setX(1);
$pt->setY(1);
$a->setAnnotationPosition($pt);
$box = new GroupDocs\Annotation\Model\Rectangle();
$box->setX(200);
$box->setY(0);
$box->setWidth(200);
$box->setHeight(100);
$a->setBox($box);
$a->setPageNumber(0);
$a->setImagePath("groupdocs.png");
$a->setPenStyle(GroupDocs\Annotation\Model\AnnotationInfo::PEN_STYLE_SOLID);
$a->setOpacity(0.7);
$a->setType(GroupDocs\Annotation\Model\AnnotationInfo::TYPE_IMAGE);
$a->setText("This is image annotation");
$a->setCreatorName("Anonym A.");   

// Pfad der Eingabedatei
$fileInfo = new GroupDocs\Annotation\Model\FileInfo();
$fileInfo->setFilePath("sample.pdf");

// Definieren Sie Anmerkungsoptionen
$options = new GroupDocs\Annotation\Model\KommentierenOptions();
$options->setFileInfo($fileInfo);
$options->setAnnotations([$a]);
$options->setOutputPath("AddImageAnnotation.pdf");

// Kommentierungsanfrage erstellen
$request = new GroupDocs\Annotation\Model\Requests\annotateRequest($options);

// Kommentieren
$result = $apiInstance->annotate($request);
echo "AddImageAnnotation: Image Annotation added: " . $result->getHref();

Fügen Sie Bildanmerkungen mit PHP hinzu.

Fügen Sie Textfeldanmerkungen mit PHP hinzu

Wir können dem PDF Dokument auch Textfeldanmerkungen hinzufügen, indem wir die zuvor genannten Schritte ausführen. Wir müssen jedoch nur den Anmerkungstyp auf „Textfeld“ setzen, wie unten gezeigt:

$a->setType(GroupDocs\Annotation\Model\AnnotationInfo::TYPE_TEXT_FIELD);

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.

// Dieses Codebeispiel zeigt, wie man Textfeldanmerkungen zu PDF hinzufügt
// AnnotationAPI-Instanz initialisieren
$apiInstance = new GroupDocs\Annotation\KommentierenApi($configuration);

// TextField-Anmerkung hinzufügen
$a = new GroupDocs\Annotation\Model\AnnotationInfo();
$pt = new GroupDocs\Annotation\Model\Point();
$pt->setX(1);
$pt->setY(1);
$a->setAnnotationPosition($pt);
$box = new GroupDocs\Annotation\Model\Rectangle();
$box->setX(380);
$box->setY(300);
$box->setWidth(100);
$box->setHeight(50);
$a->setBox($box);
$a->setPageNumber(0);
$a->setFontColor(1201033);
$a->setFontSize(12);
$a->setOpacity(0.7);
$a->setType(GroupDocs\Annotation\Model\AnnotationInfo::TYPE_TEXT_FIELD);
$a->setText("Text field text");
$a->setCreatorName("Anonym A.");   

// Pfad der Eingabedatei
$fileInfo = new GroupDocs\Annotation\Model\FileInfo();
$fileInfo->setFilePath("sample.pdf");

// Definieren Sie Anmerkungsoptionen
$options = new GroupDocs\Annotation\Model\KommentierenOptions();
$options->setFileInfo($fileInfo);
$options->setAnnotations([$a]);
$options->setOutputPath("AddTextFieldAnnotation.pdf");

// Kommentierungsanfrage erstellen
$request = new GroupDocs\Annotation\Model\Requests\annotateRequest($options);

// Kommentieren
$result = $apiInstance->annotate($request);
echo "AddTextFieldAnnotation: Text Field Annotation added: " . $result->getHref();

Fügen Sie Textfeldanmerkungen mit PHP hinzu.

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 wir gelernt, wie man:

Fügen Sie mit PHP mehrere Anmerkungen zu einer PDF-Datei hinzu.
Kommentieren Sie PDFs mit Link-, Bild und Textfeldanmerkungen in PHP.
Laden Sie die PDF-Datei programmgesteuert in die Cloud hoch.
Laden Sie die kommentierte PDF-Datei aus der Cloud herunter.

Außerdem können Sie mithilfe der Dokumentation mehr über die GroupDocs.Annotation Cloud API erfahren. 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.

PDF Annotation REST API und PHP SDK#

Kommentieren Sie PDF Dokumente mithilfe einer REST-API in PHP#

Laden Sie das Dokument hoch#

Kommentieren Sie PDF Dokumente mit PHP#

Laden Sie die kommentierte Datei herunter#

Kommentieren Sie mit Link Annotation mit PHP#

Fügen Sie Bildanmerkungen mit PHP hinzu#

Fügen Sie Textfeldanmerkungen mit PHP hinzu#

Versuchen Sie es online#

Abschluss#

Siehe auch#