REST-API für IronSecureDoc

Chaknith Bin

20. Juli 2024

Aktualisiert 20. Oktober 2024

Teilen Sie:

Translated

View the article in English

Dies ist die REST-API-Referenz für Ihre Instanz von IronSecureDoc. Dieses Tutorial setzt voraus, dass Sie bereits eine Container-Instanz laufen haben. Wenn Sie anfangen möchten, folgen Sie bitte unserem Leitfaden.

Zu Funktionen springen:

Lizenzschlüssel prüfen
PDF-Schwärzungsfunktionen
- Text redigieren
- Regulären Ausdruck redigieren
Bereich schwärzen
PDF-Signatur-Funktionalität
- PDF zertifizieren / Digitale Signatur anwenden
- PDF signieren / Signaturbild anwenden
Zertifikate / Signaturen überprüfen
PDF-Schutzfunktionalität
[{t:(
Der Platzhalter http://localhost:8080/ wird in allen Beispielen für die URL verwendet. Bitte stellen Sie sicher, dass Sie diese durch Ihre URL ersetzen.
Stellen Sie sicher, dass Sie die Platzhalterwerte (z.B. path/to/your/file.pdf, certificate_password usw.) durch tatsächliche Werte ersetzen.
Die author-, title- und subject-Header sind in allen Anforderungsbeispielen enthalten.

[GET] Gesundheitscheck

Endpunkt: http://localhost:8080/v1/document-services/ping

Endpunkt für die Zustandsprüfung, um zu überprüfen, ob der Server läuft.

Antwort: 200 OK: pong

[GET] Lizenz prüfen

Endpunkt: http://localhost:8080/v1/document-services/check-license

Überprüft die Gültigkeit der Lizenz.

Antwort: 200 OK: Gültig

[POST] Text redigieren

Endpoint: http://localhost:8080/v1/document-services/pdfs/redact-text

Verbirgt sensible Wörter in einem Dokument im PDF-Format durch echte Schwärzung. Schließen Sie eine PDF-Datei als pdf_file-Objekt im Anfragetext ein.

Erforderliche Parameter des Anfragekörpers

Name	Data Type	Description
pdf_file	application/pdf file	The PDF file to redact.
words_to_redact	array[string]	An array of words to be redacted from the document.

Optionale Parameter des Anfragekörpers

Name	Data Type	Default	Description
user_password	string	null	User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password	string	null	Owner password for the input PDF. Required if the PDF has an owner password to grant access to make modifications.
specific_pages	array[int]	null	Optionally specify pages to apply to. If left empty, all pages will apply.
draw_black_box	bool	True	Have a Black Box drawn over redacted text areas.
match_whole_word	bool	True	Allow partial matches within words be redacted too.
match_case	bool	null	Match case for the words to be redacted.
overlay_text	string	null	If your prefer an Overlay Text on the redaction area such as words or symbols, set them here. If not set, a blank character will be used.
save_as_pdfa	bool	False	Save the PDF with PDF/A-3 compliance.
save_as_pdfua	bool	False	Save the PDF with PDF/UA compliance.

Optionale Kopfzeilen

Name	Data Type	Description
author	string	Set the PDF Metadata Author property.
title	string	Set the PDF Metadata Title property.
subject	string	Set the PDF Metadata Subject property.

Beispiel:

Anfrage

Nur erforderliche Parameter:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'words_to_redact="pdf"' \
  -F 'draw_black_box=true' \
  -F 'match_whole_word=true' \
  -F 'match_case=true' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'words_to_redact="pdf"' \
  -F 'draw_black_box=true' \
  -F 'match_whole_word=true' \
  -F 'match_case=true' \

CURL

Alle erforderlichen und optionalen Parameter:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'words_to_redact="word1"' \
  -F 'words_to_redact="word2"' \
  -F 'draw_black_box=true' \
  -F 'match_whole_word=true' \
  -F 'match_case=true' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'overlay_text="REDACTED"' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'words_to_redact="word1"' \
  -F 'words_to_redact="word2"' \
  -F 'draw_black_box=true' \
  -F 'match_whole_word=true' \
  -F 'match_case=true' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'overlay_text="REDACTED"' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

CURL

Antwort:

200 OK mit der angehängten redigierten PDF-Datei.

[POST] Regulären Ausdruck redigieren

Endpunkt: http://localhost:8080/v1/document-services/pdfs/redact-regular-expression

Verbirgt sensible reguläre Ausdrücke (wie Daten, Namen oder Muster) in einem PDF-Dokument durch echte Schwärzung. Schließen Sie eine PDF-Datei als pdf_file-Objekt im Anfragetext ein.

Erforderliche Parameter des Anfragekörpers

Name	Data Type	Description
pdf_file	application/pdf file	The PDF file to redact.
regular_expression	string	Regular Expression from which matching cases will be redacted from the document.

Optionale Parameter des Anfragekörpers

Name	Data Type	Default	Description
user_password	string	null	User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password	string	null	Owner password for the input PDF. Required if the PDF has an owner password to grant access to make modifications.
specific_pages	array[int]	null	Optionally specify pages to apply to. If left empty, all pages will apply.
draw_black_box	bool	True	Have a Black Box drawn over redacted text areas.
overlay_text	string	null	If your prefer an Overlay Text on the redaction area such as words or symbols, set them here. If not set, a blank character will be used.
save_as_pdfa	bool	False	Save the PDF with PDF/A-3 compliance.
save_as_pdfua	bool	False	Save the PDF with PDF/UA compliance.

Optionale Kopfzeilen

Name	Data Type	Description
author	string	Set the PDF Metadata Author property.
title	string	Set the PDF Metadata Title property.
subject	string	Set the PDF Metadata Subject property.

Beispiel:

Anfrage

Nur erforderliche Parameter:

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'regular_expression="[0-9]"' \
  -F 'draw_black_box=true' \

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'regular_expression="[0-9]"' \
  -F 'draw_black_box=true' \

CURL

Alle erforderlichen und optionalen Parameter:

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'regular_expression="[0-9]"' \
  -F 'draw_black_box=true' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'overlay_text="%2A"' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'regular_expression="[0-9]"' \
  -F 'draw_black_box=true' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'overlay_text="%2A"' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

CURL

Antwort:

200 OK mit der angehängten redigierten PDF-Datei.

[POST] Region schwärzen

Endpunkt: http://localhost:8080/v1/document-services/pdfs/redact-region

Beschreibung: Verbirgt sensible Texte in einem bestimmten Bereich eines PDF-Dokuments durch echte Schwärzung. Schließen Sie eine PDF-Datei als pdf_file-Objekt im Anfragetext ein.

Erforderliche Parameter des Anfragekörpers

Datentyp

Optionale Parameter des Anfragekörpers

Name	Data Type	Default	Description
user_password	string	null	User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password	string	null	Owner password for the input PDF. Required if the PDF has an owner password to grant access to make modifications.
specific_pages	array[int]	null	Optionally specify pages to apply to. If left empty, all pages will apply.
draw_black_box	bool	True	Have a Black Box drawn over redacted text areas.
save_as_pdfa	bool	False	Save the PDF with PDF/A-3 compliance.
save_as_pdfua	bool	False	Save the PDF with PDF/UA compliance.

Optionale Kopfzeilen

Name	Data Type	Description
author	string	Set the PDF Metadata Author property.
title	string	Set the PDF Metadata Title property.
subject	string	Set the PDF Metadata Subject property.

Beispiel:

Anfrage

Nur erforderliche Parameter:

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'region_to_redact_x=100' \
  -F 'region_to_redact_y=150' \
  -F 'region_to_redact_w=500' \
  -F 'region_to_redact_h=400' \

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'region_to_redact_x=100' \
  -F 'region_to_redact_y=150' \
  -F 'region_to_redact_w=500' \
  -F 'region_to_redact_h=400' \

CURL

Alle erforderlichen und optionalen Parameter:

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'region_to_redact_x=100' \
  -F 'region_to_redact_y=150' \
  -F 'region_to_redact_w=500' \
  -F 'region_to_redact_h=400' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'region_to_redact_x=100' \
  -F 'region_to_redact_y=150' \
  -F 'region_to_redact_w=500' \
  -F 'region_to_redact_h=400' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

CURL

Antwort:

200 OK mit der angehängten redigierten PDF-Datei.

[POST] Zertifizieren / Digitale Signatur anwenden

Endpunkt: http://localhost:8080/v1/document-services/pdfs/certify

Beschreibung: Fügt einem PDF-Dokument eine Zertifizierung hinzu, um zu bestätigen, dass es nicht durch eine Zertifikatdatei (.p12, .pfx) manipuliert wurde. Fügen Sie eine PDF-Datei als pdf_file-Objekt in den Anfrage-Body ein und eine Zertifikatsdatei als certificate_file-Objekt in den Anfrage-Body.

Erforderliche Parameter des Anfragekörpers

Name

Datentyp

Beschreibung

pdf_file

application/pdf file

The PDF file to certify.

certificate_file

application/x-pkcs12 file

The certificate file (.p12, .pfx) to use for certification.

certificate_password

string

Password for the provided certificate file.

certificate_permissions

int

certificate_permissions value	Permissions
1	No Changes Allowed. Any further document changes will invalidate the signature.
2	Only Additional Signatures and Form Filling Allowed.
3	Only AdditionalSignatures, Form Filling, and Annotations Allowed

Optionale Parameter des Anfragekörpers

Name	Datentyp	Standard	Beschreibung
user_password	string	null	Benutzerpasswort für das Eingabe-PDF. Erforderlich, wenn das PDF ein Benutzerpasswort enthält, um Lesezugriff zu gewähren.
owner_password	string	null	Besitzerpasswort für das Eingabe-PDF. Erforderlich, wenn das PDF ein Besitzerpasswort enthält, um Änderungen vornehmen zu können.
save_as_pdfa	bool	False	Speichern des PDFs mit PDF/A-3-Konformität.
save_as_pdfua	bool	False	Speichern des PDFs mit PDF/UA-Konformität.

Optionale Kopfzeilen

Name	Data Type	Description
author	string	Set the PDF Metadata Author property.
title	string	Set the PDF Metadata Title property.
subject	string	Set the PDF Metadata Subject property.

Beispiel:

Anfrage

Nur erforderliche Parameter:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=1' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=1' \

CURL

Alle erforderlichen und optionalen Parameter:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=1' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=1' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

CURL

Antwort:

200 OK mit der beigefügten zertifizierten PDF-Datei.

[POST] Signieren mit Unterschrift und Zertifikat

Endpoint: http://localhost:8080/v1/document-services/pdfs/sign

Beschreibung: Fügt ein Bild und eine Zertifizierung zu diesem Bild in einem PDF-Dokument hinzu, um zu bestätigen, dass es nicht mittels einer Zertifikatsdatei (.p12, .pfx) manipuliert wurde. Fügen Sie eine PDF-Datei als pdf_file-Objekt in den Anfrage-Body ein und eine Zertifikatsdatei als certificate_file-Objekt in den Anfrage-Body.

Erforderliche Parameter des Anfragekörpers

Name

Datentyp

Beschreibung

pdf_file

application/pdf file

The PDF file to certify.

signature_image_file

image/jpeg or image/png file

The signature image (.png, .jpg, .jpeg) to use for certification. Can be a logo, autograph, etc.

certificate_file

application/x-pkcs12 file

The certificate file (.p12, .pfx) to use for certification.

certificate_password

string

Password for the provided certificate file.

certificate_permissions

int

certificate_permissions value	Permissions
1	No Changes Allowed. Any further document changes will invalidate the signature.
2	Only Additional Signatures and Form Filling Allowed.
3	Only AdditionalSignatures, Form Filling, and Annotations Allowed

sign_specific_page

int

Specify page to apply the image and certificate to. First page is 0. If left empty, only first page will apply.

signature_image_x

float

The X coordinate of the Rectangle region of the signature image. This starts from the top-left of the page.

signature_image_y

float

The Y coordinate of the Rectangle region of the signature image. This starts from the top-left of the page.

signature_image_w

float

The Width of the Rectangle region of the signature image. This starts from the top-left of the page.

signature_image_h

float

The Height of the Rectangle region of the signature image. This starts from the top-left of the page.

Optionale Parameter des Anfragekörpers

Name	Data Type	Default	Description
user_password	string	null	User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password	string	null	Owner password for the input PDF. Required if the PDF has an owner password to grant access to make modifications.
specific_pages	array[int]	null	Optionally specify pages to apply to. If left empty, all pages will apply.
save_as_pdfa	bool	False	Save the PDF with PDF/A-3 compliance.
save_as_pdfua	bool	False	Save the PDF with PDF/UA compliance.

Optionale Kopfzeilen

Name	Data Type	Description
author	string	Set the PDF Metadata Author property.
title	string	Set the PDF Metadata Title property.
subject	string	Set the PDF Metadata Subject property.

Beispiel:

Anfrage

Nur erforderliche Parameter:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'signature_image_file=@autograph.png;type=image/png' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=1' \
  -F 'sign_specific_page=0' \
  -F 'signature_image_x=100' \
  -F 'signature_image_y=150' \
  -F 'signature_image_w=500' \
  -F 'signature_image_h=400' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'signature_image_file=@autograph.png;type=image/png' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=1' \
  -F 'sign_specific_page=0' \
  -F 'signature_image_x=100' \
  -F 'signature_image_y=150' \
  -F 'signature_image_w=500' \
  -F 'signature_image_h=400' \

CURL

Alle erforderlichen und optionalen Parameter:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=0' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \
  -F 'sign_specific_page=0' \
  -F 'signature_image_x=100' \
  -F 'signature_image_y=150' \
  -F 'signature_image_w=500' \
  -F 'signature_image_h=400' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=0' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \
  -F 'sign_specific_page=0' \
  -F 'signature_image_x=100' \
  -F 'signature_image_y=150' \
  -F 'signature_image_w=500' \
  -F 'signature_image_h=400' \

CURL

Antwort:

200 OK mit der beigefügten zertifizierten PDF-Datei.

[POST] Signaturen überprüfen

Endpunkt: http://localhost:8080/v1/document-services/pdfs/verify-signatures

Beschreibung: Überprüft, ob das angegebene Benutzer- und Eigentümerpasswort für die pdf_file gültig sind

Erforderliche Parameter des Anfragekörpers

Name	Data Type	Description
pdf_file	application/pdf file	The PDF file to encrypt.

Optionale Parameter des Anfragekörpers

Name	Data Type	Default	Description
user_password	string	null	User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password	string	null	Owner password for the input PDF. Required if the PDF has an owner password to grant access to make modifications.

Beispiel:

Anfrage

Nur erforderliche Parameter:

curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \

curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \

YAML

Alle erforderlichen und optionalen Parameter:

curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \

curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \

YAML

Antwort:

200 OK, wenn Signaturen vorhanden sind und alle gültig sind
400 BadRequest-Ergebnis, wenn keine Signaturen vorhanden sind oder mindestens eine ungültig ist.

[POST] Verschlüsseln / Passwort & Berechtigungen hinzufügen

Endpunkt: http://localhost:8080/v1/document-services/pdfs/encrypt

Beschreibung: Fügt einer PDF-Dokument einen Sicherheitsschicht hinzu, indem es mit einem Benutzer- und Eigentümerpasswort verschlüsselt wird. Fügen Sie eine PDF-Datei als pdf_file-Objekt in den Body der Anfrage ein.

Erforderliche Parameter des Anfragekörpers

Name	Data Type	Description
pdf_file	application/pdf file	The PDF file to encrypt.
allow_extracting_content	bool	Allow the extraction of content from the PDF file.
allow_form_filling	bool	Allow the filling of forms in the resulting PDF.
allow_annotations	bool	Allow the addition or modification of annotations in the resulting PDF.
allow_printing	bool	Allow printing of the resulting PDF.
allow_modifications	bool	Allow modifications to the resulting PDF.
new_owner_password	string	New owner password for the output PDF. Grants full access, including changing permissions and passwords.

Optionale Parameter des Anfragekörpers

Name	Data Type	Default	Description
user_password	string	null	User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password	string	null	Owner password for the input PDF. Required if the PDF has an owner password to grant access to make modifications.
new_user_password	string	null	New user password for the output PDF. Grants read access and other specified permissions.
save_as_pdfa	bool	False	Save the PDF with PDF/A-3 compliance.
save_as_pdfua	bool	False	Save the PDF with PDF/UA compliance.

Optionale Kopfzeilen

Name	Data Type	Description
author	string	Set the PDF Metadata Author property.
title	string	Set the PDF Metadata Title property.
subject	string	Set the PDF Metadata Subject property.

Beispiel:

Anfrage

Nur erforderliche Parameter:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'allow_extracting_content=true' \
  -F 'allow_form_filling=true' \
  -F 'allow_annotations=true' \
  -F 'allow_printing=true' \
  -F 'allow_modifications=false' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'allow_extracting_content=true' \
  -F 'allow_form_filling=true' \
  -F 'allow_annotations=true' \
  -F 'allow_printing=true' \
  -F 'allow_modifications=false' \

CURL

Alle erforderlichen und optionalen Parameter:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'allow_extracting_content=true' \
  -F 'allow_form_filling=true' \
  -F 'allow_annotations=true' \
  -F 'allow_printing=true' \
  -F 'allow_modifications=false' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'new_user_password="p4ssw0rd"' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'allow_extracting_content=true' \
  -F 'allow_form_filling=true' \
  -F 'allow_annotations=true' \
  -F 'allow_printing=true' \
  -F 'allow_modifications=false' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'new_user_password="p4ssw0rd"' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

CURL

Antwort:

200 OK mit der verschlüsselten PDF-Datei im Anhang.

[POST] Text aus einem Dokument extrahieren

Endpunkt: http://localhost:8080/v1/document-services/pdfs/extract

Beschreibung: Extrahiert Text, der in den Seiten eines Dokuments eingebettet ist. Schließen Sie eine PDF-Datei als pdf_file-Objekt im Anfragetext ein.

Erforderliche Parameter des Anfragekörpers

Name	Data Type	Description
pdf_file	application/pdf file	The PDF file to encrypt.

Optionale Parameter des Anfragekörpers

Name	Data Type	Default	Description
user_password	string	null	User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password	string	null	Owner password for the input PDF. Required if the PDF has an owner password to grant access to make modifications.
specific_pages	array[int]	null	Optionally specify pages to apply to. If left empty, all pages will apply.

Beispiel:

Anfrage

Nur erforderliche Parameter:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \

CURL

Alle erforderlichen und optionalen Parameter:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \

CURL

Antwort:

200 OK mit dem extrahierten Text als Antwort.

[POST] Dokumentenkennwort überprüfen

Endpunkt: http://localhost:8080/v1/document-services/pdfs/verify-password

Beschreibung: Überprüft, ob das angegebene Benutzer- und Eigentümerpasswort für die pdf_file gültig sind

Erforderliche Parameter des Anfragekörpers

Name	Data Type	Description
pdf_file	application/pdf file	The PDF file.
user_password	string	User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password	string	Owner password for the input PDF.

Beispiel:

Anfrage

Nur erforderliche Parameter:

curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-password' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \

curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-password' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \

YAML

Antwort:

200 OK

Chaknith Bin

Jetzt mit dem Ingenieurteam chatten

Software-Ingenieur

Chaknith arbeitet an IronXL und IronBarcode. Er hat tiefgehende Expertise in C# und .NET und hilft, die Software zu verbessern und Kunden zu unterstützen. Seine Erkenntnisse aus Benutzerinteraktionen tragen zu besseren Produkten, Dokumentation und einem insgesamt besseren Erlebnis bei.