1. IronSecureDoc
  2. Tutorials
  3. REST-API für IronSecureDoc

REST-API für IronSecureDoc in C

Curtis Chau
Curtis Chau
Aktualisiert:
This article was translated from English: Does it need improvement?
Translated
View the article in English

Dies ist die REST-API-Referenz für Ihre IronSecureDoc-Instanz. Dieses Tutorial setzt voraus, dass Sie bereits eine Containerinstanz betreiben. Wenn Sie loslegen möchten, folgen Sie bitte unserer Anleitung.

Zu den Funktionen springen:

[{t:(

  • In allen Beispielen wird der Platzhalter http://localhost:8080/ für die URL verwendet. Bitte ersetzen Sie "" durch Ihre URL.
  • Ersetzen Sie unbedingt die Platzhalterwerte (z. B. path/to/your/file.pdf , Zertifikatspasswort , etc.) durch tatsächliche Werte.
  • Die Überschriften Autor , Titel und Thema sind in allen Anfragebeispielen enthalten. @@--KLAMMER-SCHLIESSEN--@@

[GET] Gesundheitscheck

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

Health-Check-Endpunkt zur Überprüfung, ob der Server läuft.

Antwort : 200 OK: pong

[GET] Lizenz prüfen

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

Prüft die Gültigkeit der Lizenz.

Antwort : 200 OK: Valid

[POST] Text schwärzen

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

Blendet sensible Wörter in einem PDF-Dokument mithilfe echter Schwärzung aus. Fügen Sie eine PDF-Datei als PDF-Datei Objekt in den Anfragetext ein.

Erforderliche Parameter im Anfragetext

Name Datentyp Beschreibung
PDF-Datei Anwendungs-/PDF-Datei Die zu schwärzende PDF-Datei.
Wörter_zu_redaktieren Array[Zeichenkette] Eine Liste von Wörtern, die aus dem Dokument entfernt werden sollen.

Optionale Anfragekörperparameter

Name Datentyp Standard Beschreibung
Benutzerpasswort zeichenfolge null Benutzerpasswort für die Eingabe-PDF-Datei. Erforderlich, wenn die PDF-Datei ein Benutzerpasswort für den Lesezugriff enthält.
Besitzerpasswort zeichenfolge null Besitzerpasswort für die Eingabe-PDF-Datei. Erforderlich, wenn die PDF-Datei ein Besitzerpasswort enthält, um den Zugriff zum Vornehmen von Änderungen zu gewähren.
spezifische_Seiten array[int] null Optional können Sie die Seiten angeben, auf die die Anwendung angewendet werden soll. Wenn Sie dieses Feld leer lassen, gilt die Anwendung für alle Seiten.
draw_black_box bool WAHR Lassen Sie einen schwarzen Kasten über die geschwärzten Textbereiche zeichnen.
vollständiges Wort bool WAHR Auch die Schwärzung von Teilübereinstimmungen innerhalb von Wörtern ist zulässig.
Fallübereinstimmung bool null Achten Sie auf die Groß- und Kleinschreibung der zu schwärzenden Wörter.
überlagernder Text zeichenfolge null Wenn Sie im Schwärzungsbereich einen Überlagerungstext wie Wörter oder Symbole wünschen, können Sie diese hier festlegen. Andernfalls wird ein Leerzeichen verwendet.
save_as_pdfa bool FALSCH Speichern Sie die PDF-Datei unter Einhaltung des PDF/A-3-Formats.
save_as_pdfua bool FALSCH Speichern Sie die PDF-Datei unter Einhaltung der PDF/UA-Richtlinien.

Optionale Überschriften

Name Datentyp Beschreibung
Autor zeichenfolge Legen Sie die Eigenschaft "PDF-Metadatenautor" fest.
Titel zeichenfolge Legen Sie die Eigenschaft "PDF-Metadatentitel" fest.
Thema zeichenfolge Legen Sie die Eigenschaft "PDF-Metadaten-Betreff" fest.

Beispiel:

Request

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-Datei=@sample.pdf;type=application/pdf' \
  -F 'Wörter_zu_redaktieren=pdf' \
  -F 'draw_black_box=true' \
  -F 'vollständiges Wort=true' \
  -F 'Fallübereinstimmung=true' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@sample.pdf;type=application/pdf' \
  -F 'Wörter_zu_redaktieren=pdf' \
  -F 'draw_black_box=true' \
  -F 'vollständiges Wort=true' \
  -F 'Fallübereinstimmung=true' \
SHELL

Alle erforderlichen und optionalen Parameter:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H 'Autor: Iron Software | IRONSECUREDOC' \
  -H 'Titel: WEBSITE DEMO 2024' \
  -H 'Thema: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@sample.pdf;type=application/pdf' \
  -F 'Wörter_zu_redaktieren=word1' \
  -F 'Wörter_zu_redaktieren=word2' \
  -F 'draw_black_box=true' \
  -F 'vollständiges Wort=true' \
  -F 'Fallübereinstimmung=true' \
  -F 'Benutzerpasswort=password' \
  -F 'Besitzerpasswort=5yug2RT45th32h78' \
  -F 'überlagernder Text=REDACTED' \
  -F 'spezifische_Seiten=0' \
  -F 'spezifische_Seiten=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 'Autor: Iron Software | IRONSECUREDOC' \
  -H 'Titel: WEBSITE DEMO 2024' \
  -H 'Thema: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@sample.pdf;type=application/pdf' \
  -F 'Wörter_zu_redaktieren=word1' \
  -F 'Wörter_zu_redaktieren=word2' \
  -F 'draw_black_box=true' \
  -F 'vollständiges Wort=true' \
  -F 'Fallübereinstimmung=true' \
  -F 'Benutzerpasswort=password' \
  -F 'Besitzerpasswort=5yug2RT45th32h78' \
  -F 'überlagernder Text=REDACTED' \
  -F 'spezifische_Seiten=0' \
  -F 'spezifische_Seiten=1' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \
SHELL

Response:

  • 200 OK mit der beigefügten geschwärzten PDF-Datei.

[POST] Redact Regular Expression

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

Blendet sensible Übereinstimmungen mit regulären Ausdrücken (wie Datumsangaben, Namen oder Muster) in einem PDF-Dokument mithilfe echter Schwärzung aus. Fügen Sie eine PDF-Datei als PDF-Datei Objekt in den Anfragetext ein.

Erforderliche Parameter im Anfragetext

Name Datentyp Beschreibung
PDF-Datei Anwendungs-/PDF-Datei Die zu schwärzende PDF-Datei.
regulärer Ausdruck zeichenfolge Regulärer Ausdruck, aus dem übereinstimmende Fälle aus dem Dokument entfernt werden.

Optionale Anfragekörperparameter

Name Datentyp Standard Beschreibung
Benutzerpasswort zeichenfolge null Benutzerpasswort für die Eingabe-PDF-Datei. Erforderlich, wenn die PDF-Datei ein Benutzerpasswort für den Lesezugriff enthält.
Besitzerpasswort zeichenfolge null Besitzerpasswort für die Eingabe-PDF-Datei. Erforderlich, wenn die PDF-Datei ein Besitzerpasswort enthält, um den Zugriff zum Vornehmen von Änderungen zu gewähren.
spezifische_Seiten array[int] null Optional können Sie die Seiten angeben, auf die die Anwendung angewendet werden soll. Wenn Sie dieses Feld leer lassen, gilt die Anwendung für alle Seiten.
draw_black_box bool WAHR Lassen Sie einen schwarzen Kasten über die geschwärzten Textbereiche zeichnen.
überlagernder Text zeichenfolge null Wenn Sie im Schwärzungsbereich einen Überlagerungstext wie Wörter oder Symbole wünschen, können Sie diese hier festlegen. Andernfalls wird ein Leerzeichen verwendet.
save_as_pdfa bool FALSCH Speichern Sie die PDF-Datei unter Einhaltung des PDF/A-3-Formats.
save_as_pdfua bool FALSCH Speichern Sie die PDF-Datei unter Einhaltung der PDF/UA-Richtlinien.

Optionale Überschriften

Name Datentyp Beschreibung
Autor zeichenfolge Legen Sie die Eigenschaft "PDF-Metadatenautor" fest.
Titel zeichenfolge Legen Sie die Eigenschaft "PDF-Metadatentitel" fest.
Thema zeichenfolge Legen Sie die Eigenschaft "PDF-Metadaten-Betreff" fest.

Beispiel:

Request

Nur erforderliche Parameter:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H 'Autor: Iron Software | IRONSECUREDOC' \
  -H 'Titel: WEBSITE DEMO 2024' \
  -H 'Thema: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@sample.pdf;type=application/pdf' \
  -F 'regulärer Ausdruck="[0-9]"' \
  -F 'draw_black_box=true' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H 'Autor: Iron Software | IRONSECUREDOC' \
  -H 'Titel: WEBSITE DEMO 2024' \
  -H 'Thema: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@sample.pdf;type=application/pdf' \
  -F 'regulärer Ausdruck="[0-9]"' \
  -F 'draw_black_box=true' \
SHELL

Alle erforderlichen und optionalen Parameter:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H 'Autor: Iron Software | IRONSECUREDOC' \
  -H 'Titel: WEBSITE DEMO 2024' \
  -H 'Thema: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@sample.pdf;type=application/pdf' \
  -F 'regulärer Ausdruck="[0-9]"' \
  -F 'draw_black_box=true' \
  -F 'Benutzerpasswort=password' \
  -F 'Besitzerpasswort=5yug2RT45th32h78' \
  -F 'überlagernder Text=*' \
  -F 'spezifische_Seiten=0' \
  -F 'spezifische_Seiten=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 'Autor: Iron Software | IRONSECUREDOC' \
  -H 'Titel: WEBSITE DEMO 2024' \
  -H 'Thema: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@sample.pdf;type=application/pdf' \
  -F 'regulärer Ausdruck="[0-9]"' \
  -F 'draw_black_box=true' \
  -F 'Benutzerpasswort=password' \
  -F 'Besitzerpasswort=5yug2RT45th32h78' \
  -F 'überlagernder Text=*' \
  -F 'spezifische_Seiten=0' \
  -F 'spezifische_Seiten=1' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \
SHELL

Response:

  • 200 OK mit der beigefügten geschwärzten PDF-Datei.

[POST] Schwärzungsregion

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

Blendet sensiblen Text in einem bestimmten Bereich eines PDF-Dokuments mithilfe echter Schwärzung aus. Fügen Sie eine PDF-Datei als PDF-Datei Objekt in den Anfragetext ein.

Erforderliche Parameter im Anfragetext

Name Datentyp Beschreibung
PDF-Datei Anwendungs-/PDF-Datei Die zu schwärzende PDF-Datei.
region_to_redact_x float X-Koordinate des zu schwärzenden Bereichs, beginnend unten links auf der Seite.
region_to_redact_y float Y-Koordinate des zu schwärzenden Bereichs, beginnend unten links auf der Seite.
region_to_redact_w float Breite des zu schwärzenden Bereichs, beginnend bei der angegebenen X-Koordinate.
region_to_redact_h float Höhe des zu schwärzenden Bereichs, ausgehend von der angegebenen Y-Koordinate.

Optionale Anfragekörperparameter

Name Datentyp Standard Beschreibung
Benutzerpasswort zeichenfolge null Benutzerpasswort für die Eingabe-PDF-Datei. Erforderlich, wenn die PDF-Datei ein Benutzerpasswort für den Lesezugriff enthält.
Besitzerpasswort zeichenfolge null Besitzerpasswort für die Eingabe-PDF-Datei. Erforderlich, wenn die PDF-Datei ein Besitzerpasswort enthält, um den Zugriff zum Vornehmen von Änderungen zu gewähren.
spezifische_Seiten array[int] null Optional können Sie die Seiten angeben, auf die die Anwendung angewendet werden soll. Wenn Sie dieses Feld leer lassen, gilt die Anwendung für alle Seiten.
draw_black_box bool WAHR Lassen Sie einen schwarzen Kasten über die geschwärzten Textbereiche zeichnen.
save_as_pdfa bool FALSCH Speichern Sie die PDF-Datei unter Einhaltung des PDF/A-3-Formats.
save_as_pdfua bool FALSCH Speichern Sie die PDF-Datei unter Einhaltung der PDF/UA-Richtlinien.

Optionale Überschriften

Name Datentyp Beschreibung
Autor zeichenfolge Legen Sie die Eigenschaft "PDF-Metadatenautor" fest.
Titel zeichenfolge Legen Sie die Eigenschaft "PDF-Metadatentitel" fest.
Thema zeichenfolge Legen Sie die Eigenschaft "PDF-Metadaten-Betreff" fest.

Beispiel:

Request

Nur erforderliche Parameter:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -H 'accept: */*' \
  -H 'Autor: Iron Software | IRONSECUREDOC' \
  -H 'Titel: WEBSITE DEMO 2024' \
  -H 'Thema: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@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 'Autor: Iron Software | IRONSECUREDOC' \
  -H 'Titel: WEBSITE DEMO 2024' \
  -H 'Thema: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@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' \
SHELL

Alle erforderlichen und optionalen Parameter:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -H 'accept: */*' \
  -H 'Autor: Iron Software | IRONSECUREDOC' \
  -H 'Titel: WEBSITE DEMO 2024' \
  -H 'Thema: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@sample.pdf;type=application/pdf' \
  -F 'Benutzerpasswort=password' \
  -F 'Besitzerpasswort=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 'spezifische_Seiten=0' \
  -F 'spezifische_Seiten=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 'Autor: Iron Software | IRONSECUREDOC' \
  -H 'Titel: WEBSITE DEMO 2024' \
  -H 'Thema: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@sample.pdf;type=application/pdf' \
  -F 'Benutzerpasswort=password' \
  -F 'Besitzerpasswort=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 'spezifische_Seiten=0' \
  -F 'spezifische_Seiten=1' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \
SHELL

Response:

  • 200 OK mit der beigefügten geschwärzten PDF-Datei.

[POST] Zertifizieren / Digitale Signatur anwenden

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

Fügt einem PDF-Dokument eine Bescheinigung hinzu, um mittels einer Zertifikatsdatei (.p12, .pfx) zu bestätigen, dass es nicht manipuliert wurde. Fügen Sie eine PDF-Datei als PDF-Datei Objekt und eine Zertifikatsdatei als certificate_file Objekt in den Anfragetext ein.

Erforderliche Parameter im Anfragetext

Name Datentyp Beschreibung
PDF-Datei Anwendungs-/PDF-Datei Die zu zertifizierende PDF-Datei.
certificate_file application/x-pkcs12-Datei Die für die Zertifizierung zu verwendende Zertifikatsdatei (.p12, .pfx).
Zertifikatspasswort zeichenfolge Passwort für die bereitgestellte Zertifikatsdatei.
Zertifikatsberechtigungen int
Wert von Zertifikatsberechtigungen Berechtigungen
1 Änderungen sind nicht zulässig. Jede weitere Änderung des Dokuments führt zur Ungültigkeit der Signatur.
2 Lediglich zusätzliche Unterschriften und das Ausfüllen des Formulars sind zulässig.
3 Lediglich zusätzliche Unterschriften, Formularausfüllung und Anmerkungen sind zulässig.

Optionale Anfragekörperparameter

Name Datentyp Standard Beschreibung
Benutzerpasswort zeichenfolge null Benutzerpasswort für die Eingabe-PDF-Datei. Erforderlich, wenn die PDF-Datei ein Benutzerpasswort für den Lesezugriff enthält.
Besitzerpasswort zeichenfolge null Besitzerpasswort für die Eingabe-PDF-Datei. Erforderlich, wenn die PDF-Datei ein Besitzerpasswort enthält, um den Zugriff zum Vornehmen von Änderungen zu gewähren.
save_as_pdfa bool FALSCH Speichern Sie die PDF-Datei unter Einhaltung des PDF/A-3-Formats.
save_as_pdfua bool FALSCH Speichern Sie die PDF-Datei unter Einhaltung der PDF/UA-Richtlinien.

Optionale Überschriften

Name Datentyp Beschreibung
Autor zeichenfolge Legen Sie die Eigenschaft "PDF-Metadatenautor" fest.
Titel zeichenfolge Legen Sie die Eigenschaft "PDF-Metadatentitel" fest.
Thema zeichenfolge Legen Sie die Eigenschaft "PDF-Metadaten-Betreff" fest.

Beispiel:

Request

Nur erforderliche Parameter:

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

Alle erforderlichen und optionalen Parameter:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -H 'accept: */*' \
  -H 'Autor: Iron Software | IRONSECUREDOC' \
  -H 'Titel: WEBSITE DEMO 2024' \
  -H 'Thema: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@sample.pdf;type=application/pdf' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'Zertifikatspasswort=p4ssw0rd' \
  -F 'Zertifikatsberechtigungen=1' \
  -F 'Benutzerpasswort=password' \
  -F 'Besitzerpasswort=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 'Autor: Iron Software | IRONSECUREDOC' \
  -H 'Titel: WEBSITE DEMO 2024' \
  -H 'Thema: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@sample.pdf;type=application/pdf' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'Zertifikatspasswort=p4ssw0rd' \
  -F 'Zertifikatsberechtigungen=1' \
  -F 'Benutzerpasswort=password' \
  -F 'Besitzerpasswort=5yug2RT45th32h78' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \
SHELL

Response:

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

[POST] Mit Signatur und Zertifikat signieren

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

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

Erforderliche Parameter im Anfragetext

Name Datentyp Beschreibung
PDF-Datei Anwendungs-/PDF-Datei Die zu zertifizierende PDF-Datei.
Signaturbilddatei Bilddatei (JPEG oder PNG) Das zur Zertifizierung zu verwendende Signaturbild (.png, .jpg, .jpeg). Dies kann ein Logo, eine Unterschrift usw. sein.
certificate_file application/x-pkcs12-Datei Die für die Zertifizierung zu verwendende Zertifikatsdatei (.p12, .pfx).
Zertifikatspasswort zeichenfolge Passwort für die bereitgestellte Zertifikatsdatei.
Zertifikatsberechtigungen int
Wert von Zertifikatsberechtigungen Berechtigungen
1 Änderungen sind nicht zulässig. Jede weitere Änderung des Dokuments führt zur Ungültigkeit der Signatur.
2 Lediglich zusätzliche Unterschriften und das Ausfüllen des Formulars sind zulässig.
3 Lediglich zusätzliche Unterschriften, Formularausfüllung und Anmerkungen sind zulässig.

sign_specific_page int Geben Sie die Seite an, auf die das Bild und das Zertifikat angewendet werden sollen. Die erste Seite hat den Wert 0. Wenn dieses Feld leer bleibt, werden Bild und Zertifikat nur auf der ersten Seite angewendet.
Signaturbild_x float Die X-Koordinate des rechteckigen Bereichs des Signaturbildes. Diese beginnt oben links auf der Seite.
Signaturbild_y float Die Y-Koordinate des rechteckigen Bereichs des Signaturbildes. Diese beginnt oben links auf der Seite.
Signaturbild_w float Die Breite des rechteckigen Bereichs des Signaturbildes. Diese beginnt oben links auf der Seite.
Signaturbild float Die Höhe des rechteckigen Bereichs des Signaturbildes. Diese beginnt oben links auf der Seite.

Optionale Anfragekörperparameter

Name Datentyp Standard Beschreibung
Benutzerpasswort zeichenfolge null Benutzerpasswort für die Eingabe-PDF-Datei. Erforderlich, wenn die PDF-Datei ein Benutzerpasswort für den Lesezugriff enthält.
Besitzerpasswort zeichenfolge null Besitzerpasswort für die Eingabe-PDF-Datei. Erforderlich, wenn die PDF-Datei ein Besitzerpasswort enthält, um den Zugriff zum Vornehmen von Änderungen zu gewähren.
spezifische_Seiten array[int] null Optional können Sie die Seiten angeben, auf die die Anwendung angewendet werden soll. Wenn Sie dieses Feld leer lassen, gilt die Anwendung für alle Seiten.
save_as_pdfa bool FALSCH Speichern Sie die PDF-Datei unter Einhaltung des PDF/A-3-Formats.
save_as_pdfua bool FALSCH Speichern Sie die PDF-Datei unter Einhaltung der PDF/UA-Richtlinien.

Optionale Überschriften

Name Datentyp Beschreibung
Autor zeichenfolge Legen Sie die Eigenschaft "PDF-Metadatenautor" fest.
Titel zeichenfolge Legen Sie die Eigenschaft "PDF-Metadatentitel" fest.
Thema zeichenfolge Legen Sie die Eigenschaft "PDF-Metadaten-Betreff" fest.

Beispiel:

Request

Nur erforderliche Parameter:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@sample.pdf;type=application/pdf' \
  -F 'Signaturbilddatei=@autograph.png;type=image/png' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'Zertifikatspasswort=p4ssw0rd' \
  -F 'Zertifikatsberechtigungen=1' \
  -F 'sign_specific_page=0' \
  -F 'Signaturbild_x=100' \
  -F 'Signaturbild_y=150' \
  -F 'Signaturbild_w=500' \
  -F 'Signaturbild=400' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@sample.pdf;type=application/pdf' \
  -F 'Signaturbilddatei=@autograph.png;type=image/png' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'Zertifikatspasswort=p4ssw0rd' \
  -F 'Zertifikatsberechtigungen=1' \
  -F 'sign_specific_page=0' \
  -F 'Signaturbild_x=100' \
  -F 'Signaturbild_y=150' \
  -F 'Signaturbild_w=500' \
  -F 'Signaturbild=400' \
SHELL

Alle erforderlichen und optionalen Parameter:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -H 'accept: */*' \
  -H 'Autor: Iron Software | IRONSECUREDOC' \
  -H 'Titel: WEBSITE DEMO 2024' \
  -H 'Thema: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@sample.pdf;type=application/pdf' \
  -F 'Signaturbilddatei=@autograph.png;type=image/png' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'Zertifikatspasswort=p4ssw0rd' \
  -F 'Zertifikatsberechtigungen=1' \
  -F 'Benutzerpasswort=password' \
  -F 'Besitzerpasswort=5yug2RT45th32h78' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \
  -F 'sign_specific_page=0' \
  -F 'Signaturbild_x=100' \
  -F 'Signaturbild_y=150' \
  -F 'Signaturbild_w=500' \
  -F 'Signaturbild=400' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -H 'accept: */*' \
  -H 'Autor: Iron Software | IRONSECUREDOC' \
  -H 'Titel: WEBSITE DEMO 2024' \
  -H 'Thema: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@sample.pdf;type=application/pdf' \
  -F 'Signaturbilddatei=@autograph.png;type=image/png' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'Zertifikatspasswort=p4ssw0rd' \
  -F 'Zertifikatsberechtigungen=1' \
  -F 'Benutzerpasswort=password' \
  -F 'Besitzerpasswort=5yug2RT45th32h78' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \
  -F 'sign_specific_page=0' \
  -F 'Signaturbild_x=100' \
  -F 'Signaturbild_y=150' \
  -F 'Signaturbild_w=500' \
  -F 'Signaturbild=400' \
SHELL

Response:

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

[POST] Signaturen überprüfen

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

Prüft, ob die Signaturen in der PDF-Datei gültig sind.

Erforderliche Parameter im Anfragetext

Name Datentyp Beschreibung
PDF-Datei Anwendungs-/PDF-Datei Die zu verschlüsselnde PDF-Datei.

Optionale Anfragekörperparameter

Name Datentyp Standard Beschreibung
Benutzerpasswort zeichenfolge null Benutzerpasswort für die Eingabe-PDF-Datei. Erforderlich, wenn die PDF-Datei ein Benutzerpasswort für den Lesezugriff enthält.
Besitzerpasswort zeichenfolge null Besitzerpasswort für die Eingabe-PDF-Datei. Erforderlich, wenn die PDF-Datei ein Besitzerpasswort enthält, um den Zugriff zum Vornehmen von Änderungen zu gewähren.

Beispiel:

Request

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-Datei=@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-Datei=@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 'Autor: Iron Software | IRONSECUREDOC' \
  -H 'Titel: WEBSITE DEMO 2024' \
  -H 'Thema: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@sample.pdf;type=application/pdf' \
  -F 'Benutzerpasswort=password' \
  -F 'Besitzerpasswort=5yug2RT45th32h78' \
curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \
  -H 'accept: */*' \
  -H 'Autor: Iron Software | IRONSECUREDOC' \
  -H 'Titel: WEBSITE DEMO 2024' \
  -H 'Thema: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@sample.pdf;type=application/pdf' \
  -F 'Benutzerpasswort=password' \
  -F 'Besitzerpasswort=5yug2RT45th32h78' \
YAML

Response:

  • 200 OK, wenn Unterschriften vorhanden und alle gültig sind.
  • 400 Bad Request, wenn keine Signaturen vorhanden sind oder mindestens eine ungültig ist.

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

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

Fügt einem PDF-Dokument eine zusätzliche Sicherheitsebene hinzu, indem es mit einem Benutzer- und Besitzerpasswort verschlüsselt wird. Fügen Sie eine PDF-Datei als PDF-Datei Objekt in den Anfragetext ein.

Erforderliche Parameter im Anfragetext

Name Datentyp Beschreibung
PDF-Datei Anwendungs-/PDF-Datei Die zu verschlüsselnde PDF-Datei.
Inhalt extrahieren bool Erlauben Sie das Extrahieren von Inhalten aus der PDF-Datei.
Formularausfüllung zulassen bool Ermöglichen Sie das Ausfüllen von Formularen im resultierenden PDF.
Annotationen zulassen bool Ermöglichen Sie das Hinzufügen oder Ändern von Anmerkungen im resultierenden PDF.
Drucken zulassen bool Drucken der resultierenden PDF-Datei zulassen.
Änderungen zulassen bool Änderungen an der resultierenden PDF-Datei zulassen.
neues_Besitzerpasswort zeichenfolge Neues Besitzerpasswort für die Ausgabedatei (PDF). Gewährt vollen Zugriff, einschließlich der Änderung von Berechtigungen und Passwörtern.

Optionale Anfragekörperparameter

Name Datentyp Standard Beschreibung
Benutzerpasswort zeichenfolge null Benutzerpasswort für die Eingabe-PDF-Datei. Erforderlich, wenn die PDF-Datei ein Benutzerpasswort für den Lesezugriff enthält.
Besitzerpasswort zeichenfolge null Besitzerpasswort für die Eingabe-PDF-Datei. Erforderlich, wenn die PDF-Datei ein Besitzerpasswort enthält, um den Zugriff zum Vornehmen von Änderungen zu gewähren.
neues_Benutzerpasswort zeichenfolge null Neues Benutzerpasswort für die Ausgabedatei (PDF). Gewährt Lesezugriff und weitere festgelegte Berechtigungen.
save_as_pdfa bool FALSCH Speichern Sie die PDF-Datei unter Einhaltung des PDF/A-3-Formats.
save_as_pdfua bool FALSCH Speichern Sie die PDF-Datei unter Einhaltung der PDF/UA-Richtlinien.

Optionale Überschriften

Name Datentyp Beschreibung
Autor zeichenfolge Legen Sie die Eigenschaft "PDF-Metadatenautor" fest.
Titel zeichenfolge Legen Sie die Eigenschaft "PDF-Metadatentitel" fest.
Thema zeichenfolge Legen Sie die Eigenschaft "PDF-Metadaten-Betreff" fest.

Beispiel:

Request

Nur erforderliche Parameter:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@sample.pdf;type=application/pdf' \
  -F 'Inhalt extrahieren=true' \
  -F 'Formularausfüllung zulassen=true' \
  -F 'Annotationen zulassen=true' \
  -F 'Drucken zulassen=true' \
  -F 'Änderungen zulassen=false' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@sample.pdf;type=application/pdf' \
  -F 'Inhalt extrahieren=true' \
  -F 'Formularausfüllung zulassen=true' \
  -F 'Annotationen zulassen=true' \
  -F 'Drucken zulassen=true' \
  -F 'Änderungen zulassen=false' \
SHELL

Alle erforderlichen und optionalen Parameter:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H 'Autor: Iron Software | IRONSECUREDOC' \
  -H 'Titel: WEBSITE DEMO 2024' \
  -H 'Thema: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@sample.pdf;type=application/pdf' \
  -F 'Inhalt extrahieren=true' \
  -F 'Formularausfüllung zulassen=true' \
  -F 'Annotationen zulassen=true' \
  -F 'Drucken zulassen=true' \
  -F 'Änderungen zulassen=false' \
  -F 'Benutzerpasswort=password' \
  -F 'Besitzerpasswort=5yug2RT45th32h78' \
  -F 'neues_Benutzerpasswort=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 'Autor: Iron Software | IRONSECUREDOC' \
  -H 'Titel: WEBSITE DEMO 2024' \
  -H 'Thema: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@sample.pdf;type=application/pdf' \
  -F 'Inhalt extrahieren=true' \
  -F 'Formularausfüllung zulassen=true' \
  -F 'Annotationen zulassen=true' \
  -F 'Drucken zulassen=true' \
  -F 'Änderungen zulassen=false' \
  -F 'Benutzerpasswort=password' \
  -F 'Besitzerpasswort=5yug2RT45th32h78' \
  -F 'neues_Benutzerpasswort=p4ssw0rd' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \
SHELL

Response:

  • 200 OK mit der angehängten verschlüsselten PDF-Datei.

[POST] Text aus einem Dokument extrahieren

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

Extrahiert in den Seiten eines Dokuments eingebetteten Text. Fügen Sie eine PDF-Datei als PDF-Datei Objekt in den Anfragetext ein.

Erforderliche Parameter im Anfragetext

Name Datentyp Beschreibung
PDF-Datei Anwendungs-/PDF-Datei Die zu verschlüsselnde PDF-Datei.

Optionale Anfragekörperparameter

Name Datentyp Standard Beschreibung
Benutzerpasswort zeichenfolge null Benutzerpasswort für die Eingabe-PDF-Datei. Erforderlich, wenn die PDF-Datei ein Benutzerpasswort für den Lesezugriff enthält.
Besitzerpasswort zeichenfolge null Besitzerpasswort für die Eingabe-PDF-Datei. Erforderlich, wenn die PDF-Datei ein Besitzerpasswort enthält, um den Zugriff zum Vornehmen von Änderungen zu gewähren.
spezifische_Seiten array[int] null Optional können Sie die Seiten angeben, auf die die Anwendung angewendet werden soll. Wenn Sie dieses Feld leer lassen, gilt die Anwendung für alle Seiten.

Beispiel:

Request

Nur erforderliche Parameter:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@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-Datei=@sample.pdf;type=application/pdf' \
SHELL

Alle erforderlichen und optionalen Parameter:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \
  -H 'accept: */*' \
  -H 'Autor: Iron Software | IRONSECUREDOC' \
  -H 'Titel: WEBSITE DEMO 2024' \
  -H 'Thema: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@sample.pdf;type=application/pdf' \
  -F 'Benutzerpasswort=password' \
  -F 'Besitzerpasswort=5yug2RT45th32h78' \
  -F 'spezifische_Seiten=0' \
  -F 'spezifische_Seiten=1' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \
  -H 'accept: */*' \
  -H 'Autor: Iron Software | IRONSECUREDOC' \
  -H 'Titel: WEBSITE DEMO 2024' \
  -H 'Thema: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@sample.pdf;type=application/pdf' \
  -F 'Benutzerpasswort=password' \
  -F 'Besitzerpasswort=5yug2RT45th32h78' \
  -F 'spezifische_Seiten=0' \
  -F 'spezifische_Seiten=1' \
SHELL

Response:

  • 200 OK mit dem extrahierten Text als Antwort.

[POST] Dokumentpasswort überprüfen

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

Prüft, ob die angegebenen Benutzer- und Eigentümerpasswörter für die PDF-Datei gültig sind.

Erforderliche Parameter im Anfragetext

Name Datentyp Beschreibung
PDF-Datei Anwendungs-/PDF-Datei Die PDF-Datei.
Benutzerpasswort zeichenfolge Benutzerpasswort für die Eingabe-PDF-Datei. Erforderlich, wenn die PDF-Datei ein Benutzerpasswort für den Lesezugriff enthält.
Besitzerpasswort zeichenfolge Besitzerpasswort für die Eingabe-PDF-Datei.

Beispiel:

Request

Nur erforderliche Parameter:

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/verify-password' \
  -H 'accept: */*' \
  -H 'Autor: Iron Software | IRONSECUREDOC' \
  -H 'Titel: WEBSITE DEMO 2024' \
  -H 'Thema: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@sample.pdf;type=application/pdf' \
  -F 'Benutzerpasswort=password' \
  -F 'Besitzerpasswort=5yug2RT45th32h78' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/verify-password' \
  -H 'accept: */*' \
  -H 'Autor: Iron Software | IRONSECUREDOC' \
  -H 'Titel: WEBSITE DEMO 2024' \
  -H 'Thema: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'PDF-Datei=@sample.pdf;type=application/pdf' \
  -F 'Benutzerpasswort=password' \
  -F 'Besitzerpasswort=5yug2RT45th32h78' \
SHELL

Response:

  • 200 OK

Häufig gestellte Fragen

Was ist der Zweck der IronSecureDoc REST API?

Die IronSecureDoc REST API ist darauf ausgelegt, Entwicklern zu helfen, PDF-Dokumente zu sichern und zu verwalten, indem sie Funktionen wie Textschwärzung, Anwendung digitaler Signaturen, Dokumentverschlüsselung und Passwortüberprüfung bietet.

Wie kann ich sicherstellen, dass mein Server mit dem IronSecureDoc API betriebsbereit ist?

Sie können sicherstellen, dass Ihr Server betriebsbereit ist, indem Sie eine GET-Anfrage an den `/v1/document-services/ping`-Endpunkt senden. Bei Erfolg antwortet der Server mit einem `200 OK` Status und der Nachricht `pong`.

Wie schwärze ich bestimmten Text oder Muster in einem PDF mit dem API?

Sie können bestimmten Text oder Muster in einem PDF schwärzen, indem Sie eine POST-Anfrage an den `/v1/document-services/pdfs/redact-text`-Endpunkt mit dem PDF und den Texten oder regulären Ausdrücken senden, die Sie schwärzen möchten.

Wie kann ich überprüfen, ob die digitalen Signaturen eines PDFs gültig sind?

Um digitale Signaturen in einem PDF zu überprüfen, können Sie eine POST-Anfrage an den `/v1/document-services/pdfs/verify-signatures`-Endpunkt mit der PDF-Datei senden. Das API wird Informationen zur Gültigkeit jeder Signatur zurückgeben.

Welche Schritte sind bei der Verschlüsselung eines PDFs mit der IronSecureDoc API involviert?

Um ein PDF zu verschlüsseln, senden Sie eine POST-Anfrage an den `/v1/document-services/pdfs/encrypt`-Endpunkt mit der PDF-Datei, wobei Sie Benutzer- und Besitzerpasswörter sowie alle Berechtigungen angeben, die Sie festlegen möchten, wie z.B. Inhaltsentnahme oder Formularausfüllung.

Wie kann ich ein PDF-Dokument mit der IronSecureDoc API digital signieren?

Sie können ein PDF digital signieren, indem Sie eine POST-Anfrage an den `/v1/document-services/pdfs/certify`-Endpunkt mit der PDF-Datei, einem digitalen Zertifikat und dem Zertifikat-Passwort senden.

Welche Optionen gibt es zum Schutz von PDF-Dokumenten?

Optionen zum Schutz von PDFs umfassen das Verschlüsseln des Dokuments, Setzen von Zugriffsberechtigungen, Hinzufügen von Benutzer- und Besitzerpasswörtern und Überprüfen bestehender Passwörter mit der IronSecureDoc API.

Ist es möglich, Text aus einem PDF mit der IronSecureDoc API zu extrahieren?

Ja, Sie können Text aus einem PDF extrahieren, indem Sie eine POST-Anfrage an den `/v1/document-services/pdfs/extract`-Endpunkt senden. Sie können Parameter angeben, um Text von bestimmten Seiten oder dem gesamten Dokument zu extrahieren.

Wie überprüfe ich die Passwörter eines PDF-Dokuments?

Um Passwörter zu überprüfen, senden Sie eine POST-Anfrage an den `/v1/document-services/pdfs/verify-password`-Endpunkt mit der PDF-Datei. Geben Sie sowohl Benutzer- als auch Besitzerpasswörter in Ihrer Anfrage an, um deren Gültigkeit zu bestätigen.

Was sind die Hauptfähigkeiten der IronSecureDoc REST API?

Die Hauptfähigkeiten der IronSecureDoc REST API umfassen Server-Gesundheitsprüfungen, Lizenzverifizierung, Textschwärzung, digitale Signaturanwendung, PDF-Verschlüsselung und Textextraktion.

Curtis Chau
Curtis Chau
  Jetzt mit dem Ingenieurteam chatten
Technischer Autor

Curtis Chau hat einen Bachelor-Abschluss in Informatik von der Carleton University und ist spezialisiert auf Frontend-Entwicklung mit Expertise in Node.js, TypeScript, JavaScript und React. Leidenschaftlich widmet er sich der Erstellung intuitiver und ästhetisch ansprechender Benutzerschnittstellen und arbeitet gerne mit modernen Frameworks sowie der Erstellung gut strukturierter, optisch ansprechender ...

Weiterlesen
Bereit anzufangen?
Version: 2024.10 gerade veröffentlicht