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 , certificate_password , etc.) durch tatsächliche Werte.
  • Die Überschriften author , title und subject 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_file Objekt in den Anfragetext ein.

Erforderliche Parameter im Anfragetext

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

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