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 geht davon aus, dass Sie bereits eine Container-Instanz laufen haben, wenn SieFolgen Sie bitte unserem Leitfaden für den Einstieg.

Zu Funktionen springen:

Lizenzschlüssel überprüfen
PDF-Schwärzungsfunktionen
- Text bearbeiten
- Regulären Ausdruck umschreiben
Region schwärzen
PDF-Signatur-Funktionalität
- PDF zertifizieren / Digitale Signatur anwenden
- PDF signieren / Unterschriftsbild anwenden
Verify Certificates/Signatures
PDF-Schutzfunktionalität
Tipps
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 ersetzen(z. B. Pfad/zu/Ihr/Datei.pdf, Zertifikat_Kennwort usw.) mit tatsächlichen Werten.
Die Kopfzeilen author, title und subject sind in allen Anfragebeispielen 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

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

Verbirgt sensible Wörter in einem Dokument im PDF-Format durch echte Schwärzung. Fügen Sie eine PDF-Datei als pdf_file-Objekt in den Anfragekörper ein.

Erforderliche Parameter des Anfragekörpers

Name	Datentyp	Beschreibung
pdf_datei	application/pdf-Datei	Die zu schwärzende PDF-Datei.
Wörter_zum_Rotwerden	Array[String]	Ein Array von Wörtern, die aus dem Dokument geschwärzt werden sollen.

Optionale Parameter des Anfragekörpers

Name	Datentyp	Standard	Beschreibung
Benutzer_Passwort	string	null	Benutzerpasswort für das Eingabe-PDF. Erforderlich, wenn das PDF ein Benutzerpasswort hat, um Lesezugriff zu gewähren.
Besitzerkennwort	string	null	Besitzerpasswort für das Eingabe-PDF. Erforderlich, wenn das PDF ein Besitzerpasswort hat, um Zugriff zur Durchführung von Änderungen zu gewähren.
spezifische_Seiten	Array[int]	null	Optional können Sie die Seiten angeben, auf die es angewendet werden soll. Wenn nichts angegeben ist, wird es auf alle Seiten angewendet.
draw_black_box	bool	Wahr	Eine Black Box über geschwärzten Textbereichen zeichnen lassen.
ganze_Wort_suchen	bool	Wahr	Erlaube auch das Redigieren von Teilübereinstimmungen innerhalb von Wörtern.
Groß-/Kleinschreibung beachten	bool	null	Übereinstimmung der Groß- und Kleinschreibung für die zu redigierenden Wörter.
Überlagerungstext	string	null	Falls Sie einen Überlagerungstext im Schwärzungsbereich wie Wörter oder Symbole bevorzugen, legen Sie diese hier fest. Wenn nicht festgelegt, wird ein Leerzeichen verwendet.
Als_PDF/A_speichern	bool	Falsch	Speichern Sie das PDF mit PDF/A-3-Konformität.
save_as_pdfua	bool	Falsch	Speichern Sie das PDF mit PDF/UA-Konformität.

Optionale Kopfzeilen

Name	Datentyp	Beschreibung
Autor	string	Legen Sie die PDF-Metadaten Author-Eigenschaft fest.
titel	string	Legen Sie die Eigenschaft PDF Metadata Title fest.
Betreff	string	Legen Sie die PDF-Metadaten-Eigenschaft "Subject" fest.

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

Versteckt empfindliche Übereinstimmungen mit regulären Ausdrücken(wie Daten, Namen oder Muster) in einem Dokument im PDF-Format mit echter Schwärzung. Fügen Sie eine PDF-Datei als pdf_file-Objekt in den Anfragekörper ein.

Erforderliche Parameter des Anfragekörpers

Name	Datentyp	Beschreibung
pdf_datei	application/pdf-Datei	Die zu schwärzende PDF-Datei.
regulärer_Ausdruck	string	Regulärer Ausdruck, aus dem passende Fälle aus dem Dokument entfernt werden.

Optionale Parameter des Anfragekörpers

Name	Datentyp	Standard	Beschreibung
Benutzer_Passwort	string	null	Benutzerpasswort für das Eingabe-PDF. Erforderlich, wenn das PDF ein Benutzerpasswort hat, um Lesezugriff zu gewähren.
Besitzerkennwort	string	null	Besitzerpasswort für das Eingabe-PDF. Erforderlich, wenn das PDF ein Besitzerpasswort hat, um Zugriff zur Durchführung von Änderungen zu gewähren.
spezifische_Seiten	Array[int]	null	Optional können Sie die Seiten angeben, auf die es angewendet werden soll. Wenn nichts angegeben ist, wird es auf alle Seiten angewendet.
draw_black_box	bool	Wahr	Eine Black Box über geschwärzten Textbereichen zeichnen lassen.
Überlagerungstext	string	null	Falls Sie einen Überlagerungstext im Schwärzungsbereich wie Wörter oder Symbole bevorzugen, legen Sie diese hier fest. Wenn nicht festgelegt, wird ein Leerzeichen verwendet.
Als_PDF/A_speichern	bool	Falsch	Speichern Sie das PDF mit PDF/A-3-Konformität.
save_as_pdfua	bool	Falsch	Speichern Sie das PDF mit PDF/UA-Konformität.

Optionale Kopfzeilen

Name	Datentyp	Beschreibung
Autor	string	Legen Sie die PDF-Metadaten Author-Eigenschaft fest.
titel	string	Legen Sie die Eigenschaft PDF Metadata Title fest.
Betreff	string	Legen Sie die PDF-Metadaten-Eigenschaft "Subject" fest.

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: Versteckt sensiblen Text in einem bestimmten Bereich eines PDF-Dokuments mit echter Schwärzung. Fügen Sie eine PDF-Datei als pdf_file-Objekt in den Anfragekörper ein.

Erforderliche Parameter des Anfragekörpers

Name	Datentyp	Beschreibung
pdf_datei	application/pdf-Datei	Die zu schwärzende PDF-Datei.
region_to_redact_x	schwimmer	X-Koordinate des Bereichs, der zu redigieren ist, beginnend von der unteren linken Ecke der Seite.
region_to_redact_y	schwimmer	Y-Koordinate des zu schwärzenden Bereichs, beginnend von unten links der Seite.
region_to_redact_w	schwimmer	Breite des Bereichs, der geschwärzt werden soll, beginnend ab der angegebenen X-Koordinate.
region_to_redact_h	schwimmer	Höhe des Bereichs, der geschwärzt werden soll, beginnend ab der angegebenen Y-Koordinate.

Optionale Parameter des Anfragekörpers

Name	Datentyp	Standard	Beschreibung
Benutzer_Passwort	string	null	Benutzerpasswort für das Eingabe-PDF. Erforderlich, wenn das PDF ein Benutzerpasswort hat, um Lesezugriff zu gewähren.
Besitzerkennwort	string	null	Besitzerpasswort für das Eingabe-PDF. Erforderlich, wenn das PDF ein Besitzerpasswort hat, um Zugriff zur Durchführung von Änderungen zu gewähren.
spezifische_Seiten	Array[int]	null	Optional können Sie die Seiten angeben, auf die es angewendet werden soll. Wenn nichts angegeben ist, wird es auf alle Seiten angewendet.
draw_black_box	bool	Wahr	Eine Black Box über geschwärzten Textbereichen zeichnen lassen.
Als_PDF/A_speichern	bool	Falsch	Speichern Sie das PDF mit PDF/A-3-Konformität.
save_as_pdfua	bool	Falsch	Speichern Sie das PDF mit PDF/UA-Konformität.

Optionale Kopfzeilen

Name	Datentyp	Beschreibung
Autor	string	Legen Sie die PDF-Metadaten Author-Eigenschaft fest.
titel	string	Legen Sie die Eigenschaft PDF Metadata Title fest.
Betreff	string	Legen Sie die PDF-Metadaten-Eigenschaft "Subject" fest.

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 manipuliert wurde, und zwar mit Hilfe einer Zertifikatsdatei(.p12, .pfx). Fügen Sie eine PDF-Datei als "pdf_file"-Objekt und eine Zertifikatsdatei als "certificate_file"-Objekt in den Anforderungskörper ein.

Erforderliche Parameter des Anfragekörpers

Name

Datentyp

Beschreibung

pdf_datei

application/pdf-Datei

Die zu zertifizierende PDF-Datei.

Zertifikatsdatei

application/x-pkcs12-Datei

Die Zertifikatdatei (.p12, .pfx) zur Verwendung für die Zertifizierung.

Zertifikat_Passwort

string

Passwort für die bereitgestellte Zertifikatsdatei.

Zertifikat_Berechtigungen

int

Zertifikatsberechtigungen Wert	Berechtigungen
	Keine Änderungen erlaubt. Weitere Dokumentänderungen machen die Signatur ungültig.
	Nur zusätzliche Signaturen und Formularausfüllungen erlaubt.
	Nur zusätzliche Signaturen, Formularausfüllung und Anmerkungen erlaubt

Optionale Parameter des Anfragekörpers

Name	Datentyp	Standard	Beschreibung
Benutzer_Passwort	string	null	Benutzerpasswort für das Eingabe-PDF. Erforderlich, wenn das PDF ein Benutzerpasswort hat, um Lesezugriff zu gewähren.
Besitzerkennwort	string	null	Besitzerpasswort für das Eingabe-PDF. Erforderlich, wenn das PDF ein Besitzerpasswort hat, um Zugriff zur Durchführung von Änderungen zu gewähren.
Als_PDF/A_speichern	bool	Falsch	Speichern Sie das PDF mit PDF/A-3-Konformität.
save_as_pdfua	bool	Falsch	Speichern Sie das PDF mit PDF/UA-Konformität.

Optionale Kopfzeilen

Name	Datentyp	Beschreibung
Autor	string	Legen Sie die PDF-Metadaten Author-Eigenschaft fest.
titel	string	Legen Sie die Eigenschaft PDF Metadata Title fest.
Betreff	string	Legen Sie die PDF-Metadaten-Eigenschaft "Subject" fest.

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

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

Beschreibung: Fügt ein Bild und eine Zertifizierung zu diesem Bild in ein PDF-Dokument ein, um mithilfe einer Zertifikatdatei zu bestätigen, dass es nicht manipuliert wurde.(.p12, .pfx). Fügen Sie eine PDF-Datei als "pdf_file"-Objekt und eine Zertifikatsdatei als "certificate_file"-Objekt in den Anforderungskörper ein.

Erforderliche Parameter des Anfragekörpers

Name

Datentyp

Beschreibung

pdf_datei

application/pdf-Datei

Die zu zertifizierende PDF-Datei.

Unterschrift_Bild_Datei

image/jpeg oder image/png Datei

Das Signaturbild (.png, .jpg, .jpeg) zur Verwendung für die Zertifizierung. Kann ein Logo, Autogramm usw. sein.

Zertifikatsdatei

application/x-pkcs12-Datei

Die Zertifikatdatei (.p12, .pfx) zur Verwendung für die Zertifizierung.

Zertifikat_Passwort

string

Passwort für die bereitgestellte Zertifikatsdatei.

Zertifikat_Berechtigungen

int

Zertifikatsberechtigungen Wert	Berechtigungen
	Keine Änderungen erlaubt. Weitere Dokumentänderungen machen die Signatur ungültig.
	Nur zusätzliche Signaturen und Formularausfüllungen erlaubt.
	Nur zusätzliche Signaturen, Formularausfüllung und Anmerkungen erlaubt

sign_specific_page

int

Geben Sie die Seite an, auf die das Bild und das Zertifikat angewendet werden sollen. Die erste Seite ist 0. Wenn nichts angegeben wird, wird nur die erste Seite angewendet.

Signaturbild_x

schwimmer

Die X-Koordinate des Rechteckbereichs des Signaturbildes. Diese beginnt oben links auf der Seite.

Unterschriftsbild_y

schwimmer

Die Y-Koordinate des Rechteckbereichs des Signaturbildes. Diese beginnt in der oberen linken Ecke der Seite.

signature_image_w

schwimmer

Die Breite des rechteckigen Bereichs des Signaturbildes. Diese beginnt oben links auf der Seite.

signature_image_h

schwimmer

Die Höhe des Rechteckbereichs des Signaturbildes. Diese beginnt oben links auf der Seite.

Optionale Parameter des Anfragekörpers

Name	Datentyp	Standard	Beschreibung
Benutzer_Passwort	string	null	Benutzerpasswort für das Eingabe-PDF. Erforderlich, wenn das PDF ein Benutzerpasswort hat, um Lesezugriff zu gewähren.
Besitzerkennwort	string	null	Besitzerpasswort für das Eingabe-PDF. Erforderlich, wenn das PDF ein Besitzerpasswort hat, um Zugriff zur Durchführung von Änderungen zu gewähren.
spezifische_Seiten	Array[int]	null	Optional können Sie die Seiten angeben, auf die es angewendet werden soll. Wenn nichts angegeben ist, wird es auf alle Seiten angewendet.
Als_PDF/A_speichern	bool	Falsch	Speichern Sie das PDF mit PDF/A-3-Konformität.
save_as_pdfua	bool	Falsch	Speichern Sie das PDF mit PDF/UA-Konformität.

Optionale Kopfzeilen

Name	Datentyp	Beschreibung
Autor	string	Legen Sie die PDF-Metadaten Author-Eigenschaft fest.
titel	string	Legen Sie die Eigenschaft PDF Metadata Title fest.
Betreff	string	Legen Sie die PDF-Metadaten-Eigenschaft "Subject" fest.

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

Endpoint: 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	Datentyp	Beschreibung
pdf_datei	application/pdf-Datei	Die zu verschlüsselnde PDF-Datei.

Optionale Parameter des Anfragekörpers

Name	Datentyp	Standard	Beschreibung
Benutzer_Passwort	string	null	Benutzerpasswort für das Eingabe-PDF. Erforderlich, wenn das PDF ein Benutzerpasswort hat, um Lesezugriff zu gewähren.
Besitzerkennwort	string	null	Besitzerpasswort für das Eingabe-PDF. Erforderlich, wenn das PDF ein Besitzerpasswort hat, um Zugriff zur Durchführung von Änderungen zu gewähren.

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 einem PDF-Dokument eine zusätzliche Sicherheitsebene 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	Datentyp	Beschreibung
pdf_datei	application/pdf-Datei	Die zu verschlüsselnde PDF-Datei.
allow_extracting_content	bool	Ermöglichen Sie die Extraktion von Inhalten aus der PDF-Datei.
Formularausfüllung zulassen	bool	Erlauben Sie das Ausfüllen von Formularen im resultierenden PDF.
erlaube_Anmerkungen	bool	Ermöglichen Sie das Hinzufügen oder Ändern von Anmerkungen im resultierenden PDF.
Drucken erlauben	bool	Erlauben Sie das Drucken der resultierenden PDF-Datei.
Änderungen_erlauben	bool	Erlaube Änderungen am resultierenden PDF.
new_owner_password	string	Neues Besitzerpasswort für das Ausgabepdf. Gewährt vollen Zugriff, einschließlich der Änderung von Berechtigungen und Passwörtern.

Optionale Parameter des Anfragekörpers

Name	Datentyp	Standard	Beschreibung
Benutzer_Passwort	string	null	Benutzerpasswort für das Eingabe-PDF. Erforderlich, wenn das PDF ein Benutzerpasswort hat, um Lesezugriff zu gewähren.
Besitzerkennwort	string	null	Besitzerpasswort für das Eingabe-PDF. Erforderlich, wenn das PDF ein Besitzerpasswort hat, um Zugriff zur Durchführung von Änderungen zu gewähren.
neues_benutzer_passwort	string	null	Neues Benutzerpasswort für das Ausgabe-PDF. Gewährt Lesezugriff und andere festgelegte Berechtigungen.
Als_PDF/A_speichern	bool	Falsch	Speichern Sie das PDF mit PDF/A-3-Konformität.
save_as_pdfua	bool	Falsch	Speichern Sie das PDF mit PDF/UA-Konformität.

Optionale Kopfzeilen

Name	Datentyp	Beschreibung
Autor	string	Legen Sie die PDF-Metadaten Author-Eigenschaft fest.
titel	string	Legen Sie die Eigenschaft PDF Metadata Title fest.
Betreff	string	Legen Sie die PDF-Metadaten-Eigenschaft "Subject" fest.

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 die Seiten eines Dokuments eingebettet ist. Fügen Sie eine PDF-Datei als pdf_file-Objekt in den Anfragekörper ein.

Erforderliche Parameter des Anfragekörpers

Name	Datentyp	Beschreibung
pdf_datei	application/pdf-Datei	Die zu verschlüsselnde PDF-Datei.

Optionale Parameter des Anfragekörpers

Name	Datentyp	Standard	Beschreibung
Benutzer_Passwort	string	null	Benutzerpasswort für das Eingabe-PDF. Erforderlich, wenn das PDF ein Benutzerpasswort hat, um Lesezugriff zu gewähren.
Besitzerkennwort	string	null	Besitzerpasswort für das Eingabe-PDF. Erforderlich, wenn das PDF ein Besitzerpasswort hat, um Zugriff zur Durchführung von Änderungen zu gewähren.
spezifische_Seiten	Array[int]	null	Optional können Sie die Seiten angeben, auf die es angewendet werden soll. Wenn nichts angegeben ist, wird es auf alle Seiten angewendet.

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	Datentyp	Beschreibung
pdf_datei	application/pdf-Datei	Die PDF-Datei.
Benutzer_Passwort	string	Benutzerpasswort für das Eingabe-PDF. Erforderlich, wenn das PDF ein Benutzerpasswort hat, um Lesezugriff zu gewähren.
Besitzerkennwort	string	Eigentümer Passwort für die Eingabe-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.