Anotujte dokumenty PDF pomocí REST API v PHP

Anotace poskytují další informace o jakékoli konkrétní části dokumentu. Dokumenty můžeme označit zpětnou vazbou a recenzemi pomocí anotací. K dokumentům PDF můžeme přidávat obrázky, komentáře, poznámky nebo jiné typy externích poznámek jako anotace. V tomto článku se naučíme, jak anotovat dokumenty PDF pomocí REST API v PHP.

V tomto článku se budou zabývat následujícími tématy:

PDF Anotace REST API a PHP SDK

Pro anotování PDF dokumentů budeme používat PHP SDK of GroupDocs.Annotation Cloud API. Umožňuje přidávat anotace, překryvy vodoznaku, nahrazování textu, redigování a textová označení do podporovaných formátů dokumentů. Nainstalujte jej pomocí následujícího příkazu v konzole:

composer require groupdocscloud/groupdocs-annotation-cloud

Po instalaci použijte autoload skladatelů k použití sady SDK, jak je uvedeno níže:

require_once('vendor/autoload.php');

Před provedením uvedených kroků získejte své ID klienta a tajný klíč z řídicího panelu. Jakmile budete mít své ID a tajemství, přidejte kód, jak je uvedeno níže:

// Tento příklad kódu ukazuje, jak do kódu přidat ID klienta a tajný klíč.
static $ClientId = '659fe7da-715b-4744-a0f7-cf469a392b73';
static $ClientSecret = 'b377c36cfa28fa69960ebac6b6e36421';

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

// Inicializace konfigurace
$configuration = new GroupDocs\Annotation\Configuration();

// Nastavení konfigurací
$configuration->setAppSid(self::$ClientId);
$configuration->setAppKey(self::$ClientSecret);
$configuration->setApiBaseUrl(self::$ApiBaseUrl);

Anotujte dokumenty PDF pomocí REST API v PHP

Dokumenty PDF můžeme v cloudu anotovat pomocí následujících jednoduchých kroků:

  1. Nahrát soubor PDF do cloudu
  2. Anotovat dokument PDF
  3. Stáhnout anotovaný soubor

Nahrajte dokument

Nejprve nahrajeme soubor PDF do cloudu pomocí následující ukázky kódu:

// Tento příklad kódu ukazuje, jak nahrát soubor PDF do cloudu.
// Inicializujte instanci rozhraní API
$apiInstance = new GroupDocs\Annotation\FileApi($configuration);

// Cesta k souboru
$file = "C:\\Files\\Annotation\\sample.pdf";

// Vytvořit žádost o nahrání souboru
$request = new GroupDocs\Annotation\Model\Requests\UploadFileRequest("sample.pdf", $file, self::$MyStorage, null);

// Nahrát soubor
$response = $apiInstance->uploadFile($request);

V důsledku toho bude nahraný soubor PDF k dispozici v sekce souborů řídicího panelu v cloudu.

Anotujte dokument PDF pomocí PHP

Nyní do nahraného dokumentu PDF přidáme více anotací programově podle následujících kroků:

  • Nejprve vytvořte instanci AnnotateApi.
  • Dále nastavte vlastnosti anotace, např. pozici, typ, text atd.
  • Poté opakujte výše uvedený krok a přidejte více anotací.
  • Dále zadejte cestu k vstupnímu souboru.
  • Poté inicializujte objekt AnnotateOptions a nastavte cestu k výstupnímu souboru.
  • Poté vytvořte AnnotateRequest s AnnotateOptions jako argumentem.
  • Nakonec anotujte PDF pomocí metody AnnotateApi.annotate().

Následující ukázka kódu ukazuje, jak přidat více anotací do dokumentu PDF pomocí REST API v PHP.

// Tento příklad kódu ukazuje, jak do PDF přidat více anotací.
// Inicializujte instanci AnnotationAPI
$apiInstance = new GroupDocs\Annotation\Opatřit poznámkamiApi($configuration);

// Přidejte anotaci vzdálenosti
$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.");  

// Přidejte anotaci oblasti
$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.");   

// Přidejte anotaci bodu
$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.");  

// Přidejte anotaci šipky
$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.");  

// Vstupní cesta k souboru
$fileInfo = new GroupDocs\Annotation\Model\FileInfo();
$fileInfo->setFilePath("sample.pdf");

// Definujte možnosti anotací
$options = new GroupDocs\Annotation\Model\Opatřit poznámkamiOptions();
$options->setFileInfo($fileInfo);
$options->setAnnotations([$a, $a1, $a2, $a3]);
$options->setOutputPath("MultipleAnnotation.pdf");

// Vytvořit žádost o anotaci
$request = new GroupDocs\Annotation\Model\Requests\annotateRequest($options);

// Opatřit poznámkami
$result = $apiInstance->annotate($request);
echo "AddMultipleAnnotations: Multiple Annotations added: " . $result->getHref();
Anotujte dokument PDF pomocí PHP

Anotujte dokument PDF pomocí PHP.

Více o podporovaných typech anotací si můžete přečíst v sekci přidávání anotací v dokumentaci.

Stáhněte si soubor s poznámkami

Výše uvedená ukázka kódu uloží anotovaný soubor PDF do cloudu. Lze jej stáhnout pomocí následující ukázky kódu:

// Tento příklad kódu ukazuje, jak stáhnout soubor PDF z cloudu.
// Inicializace instance rozhraní API
$apiInstance = new GroupDocs\Annotation\FileApi($configuration);

// Vytvořit požadavek na stažení souboru
$request = new GroupDocs\Annotation\Model\Requests\DownloadFileRequest("MultipleAnnotation.pdf", self::$MyStorage, null);

// Stáhnout soubor
$response = $apiInstance->downloadFile($request);

Do dokumentu PDF můžeme také přidat anotaci hypertextového odkazu podle následujících kroků:

  • Nejprve vytvořte instanci AnnotateApi.
  • Dále nastavte vlastnosti anotace, např. pozici, text atd.
  • Poté nastavte typ anotace jako Odkaz.
  • Dále zadejte cestu k vstupnímu souboru.
  • Poté inicializujte objekt AnnotateOptions a nastavte cestu k výstupnímu souboru.
  • Poté vytvořte AnnotateRequest s AnnotateOptions jako argumentem.
  • Nakonec anotujte PDF pomocí metody AnnotateApi.annotate().

Následující ukázka kódu ukazuje, jak přidat anotaci hypertextového odkazu do dokumentu PDF pomocí REST API. Chcete-li nahrát a stáhnout soubor, postupujte podle výše uvedených kroků.

// Tento příklad kódu ukazuje, jak přidat anotaci odkazu do PDF
// Inicializujte instanci AnnotationAPI
$apiInstance = new GroupDocs\Annotation\Opatřit poznámkamiApi($configuration);

// Přidat anotaci odkazu
$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.");   

// Vstupní cesta k souboru
$fileInfo = new GroupDocs\Annotation\Model\FileInfo();
$fileInfo->setFilePath("sample.pdf");

// Definujte možnosti anotací
$options = new GroupDocs\Annotation\Model\Opatřit poznámkamiOptions();
$options->setFileInfo($fileInfo);
$options->setAnnotations([$a]);
$options->setOutputPath("AddLinkAnnotation.pdf");

// Vytvořit žádost o anotaci
$request = new GroupDocs\Annotation\Model\Requests\annotateRequest($options);

// Opatřit poznámkami
$result = $apiInstance->annotate($request);
echo "AddLinkAnnotation: Link Annotation added: " . $result->getHref();
Anotace pomocí Anotace odkazů pomocí PHP.

Anotace pomocí Anotace odkazů pomocí PHP.

Přidejte anotaci obrázku pomocí PHP

Do dokumentu PDF můžeme přidat anotaci obrázku podle výše uvedených kroků. Potřebujeme však pouze nastavit typ anotace na obrázek, jak je znázorněno níže:

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

Následující ukázka kódu ukazuje, jak přidat anotaci obrázku do dokumentu PDF pomocí REST API v PHP. Chcete-li nahrát a stáhnout soubor, postupujte podle výše uvedených kroků.

// Tento příklad kódu ukazuje, jak přidat anotaci obrázku do PDF
// Inicializujte instanci AnnotationAPI
$apiInstance = new GroupDocs\Annotation\Opatřit poznámkamiApi($configuration);

// Přidat anotaci obrázku
$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.");   

// Vstupní cesta k souboru
$fileInfo = new GroupDocs\Annotation\Model\FileInfo();
$fileInfo->setFilePath("sample.pdf");

// Definujte možnosti anotací
$options = new GroupDocs\Annotation\Model\Opatřit poznámkamiOptions();
$options->setFileInfo($fileInfo);
$options->setAnnotations([$a]);
$options->setOutputPath("AddImageAnnotation.pdf");

// Vytvořit žádost o anotaci
$request = new GroupDocs\Annotation\Model\Requests\annotateRequest($options);

// Opatřit poznámkami
$result = $apiInstance->annotate($request);
echo "AddImageAnnotation: Image Annotation added: " . $result->getHref();
Přidejte anotaci obrázku pomocí PHP.

Přidejte anotaci obrázku pomocí PHP.

Přidejte anotaci textového pole pomocí PHP

Do dokumentu PDF můžeme také přidat anotaci textového pole podle výše uvedených kroků. Potřebujeme však pouze nastavit typ anotace na textové pole, jak je uvedeno níže:

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

Následující ukázka kódu ukazuje, jak přidat anotaci textového pole do dokumentu PDF pomocí REST API. Chcete-li nahrát a stáhnout soubor, postupujte podle výše uvedených kroků.

// Tento příklad kódu ukazuje, jak přidat anotaci textového pole do PDF
// Inicializujte instanci AnnotationAPI
$apiInstance = new GroupDocs\Annotation\Opatřit poznámkamiApi($configuration);

// Přidejte anotaci TextField
$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.");   

// Vstupní cesta k souboru
$fileInfo = new GroupDocs\Annotation\Model\FileInfo();
$fileInfo->setFilePath("sample.pdf");

// Definujte možnosti poznámek
$options = new GroupDocs\Annotation\Model\Opatřit poznámkamiOptions();
$options->setFileInfo($fileInfo);
$options->setAnnotations([$a]);
$options->setOutputPath("AddTextFieldAnnotation.pdf");

// Vytvořit žádost o anotaci
$request = new GroupDocs\Annotation\Model\Requests\annotateRequest($options);

// Opatřit poznámkami
$result = $apiInstance->annotate($request);
echo "AddTextFieldAnnotation: Text Field Annotation added: " . $result->getHref();
Přidejte anotaci textového pole pomocí PHP.

Přidejte anotaci textového pole pomocí PHP.

Vyzkoušejte online

Vyzkoušejte prosím následující bezplatný online nástroj pro anotaci PDF, který je vyvinut pomocí výše uvedeného API. https://products.groupdocs.app/annotation/pdf

Závěr

V tomto článku jsme se naučili, jak:

  • přidat více anotací do PDF pomocí PHP;
  • anotovat PDF pomocí odkazu, obrázku a anotací textových polí v PHP;
  • programově nahrát soubor PDF do cloudu;
  • stáhněte si anotovaný soubor PDF z cloudu.

Kromě toho se můžete dozvědět více o GroupDocs.Annotation Cloud API pomocí dokumentace. Poskytujeme také sekci API Reference, která vám umožní vizualizovat a pracovat s našimi API přímo prostřednictvím prohlížeče. V případě jakýchkoliv nejasností nás neváhejte kontaktovat na fóru.

Viz také