1. IronSecureDoc
  2. Samouczki
  3. REST API dla IronSecureDoc

REST API for IronSecureDoc in C

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

Jest to Dokumentacja API dla Twojej instancji IronSecureDoc. Ten tutorial zakłada, że masz już uruchomioną instancję kontenera. Jeśli chcesz Pierwsze kroki, przeczytaj nasz przewodnik.

Przejdź do funkcji:

Porady

  • Wartoscia zastepcza http://localhost:8080/ bedzie URL we wszystkich przykladach. Upewnij się, że zamienisz go na swój URL.
  • Upewnij sie, ze zastepujesz wartosci zastepcze (np. path/to/your/file.pdf, certificate_password, itp.) rzeczywistymi wartosciami.
  • Naglowki author, title, i subject sa dolaczone do wszystkich przykladow zadan. )]

[GET] Sprawdzenie zdrowia

Adres koncowy: http://localhost:8080/v1/document-services/ping

Punkt końcowy do sprawdzania, czy serwer działa.

Odpowiedz: 200 OK: pong

[GET] Sprawdz licencje

Adres koncowy: http://localhost:8080/v1/document-services/check-license

Weryfikuje ważność licencji.

Odpowiedz: 200 OK: Valid

[POST] Redagowanie tekstu

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

Ukrywa wrażliwe słowa w dokumencie w formacie PDF za pomocą prawdziwej redakcji. Dolacz plik PDF jako obiekt pdf_file w tresci zadania.

Obowiązkowe Parametry Treści Żądania

ImięTyp danychOpis
plik_pdfapplication/pdf plikPlik PDF do redakcji.
słowa_do_ukryciatablica[ciąg]Tablica słów do zredagowania z dokumentu.

Często Zadawane Pytania

Jaki jest cel API REST IronSecureDoc?

API REST IronSecureDoc jest zaprojektowane, aby pomóc deweloperom zabezpieczać i zarządzać dokumentami PDF, oferując funkcjonalności takie jak redagowanie tekstu, stosowanie podpisów cyfrowych, szyfrowanie dokumentów i weryfikacja haseł.

Jak mogę upewnić się, że mój serwer działa z API IronSecureDoc?

Możesz upewnić się, że Twój serwer działa, wysyłając żądanie GET do punktu końcowego `/v1/document-services/ping`. Jeśli żądanie zakończy się sukcesem, serwer odpowie statusem `200 OK` i wiadomością `pong`.

Jak mam redagować specyficzny tekst lub wzorce w PDF używając API?

Możesz redagować specyficzny tekst lub wzorce w PDF, wysyłając żądanie POST do punktu końcowego `/v1/document-services/pdfs/redact-text` z PDF-em i tekstem lub wyrażeniami regularnymi, które chcesz zredagować.

Jak mogę zweryfikować, czy podpisy cyfrowe w PDF są ważne?

Aby zweryfikować podpisy cyfrowe w PDF, możesz wysłać żądanie POST do punktu końcowego `/v1/document-services/pdfs/verify-signatures` z plikiem PDF. API zwróci informacje na temat ważności każdego podpisu.

Jakie kroki są związane z szyfrowaniem PDF przy użyciu API IronSecureDoc?

Aby zaszyfrować PDF, wyślij żądanie POST do punktu końcowego `/v1/document-services/pdfs/encrypt` z plikiem PDF, określając hasła użytkownika i właściciela oraz wszelkie uprawnienia, które chcesz ustawić, takie jak wyciąganie zawartości lub wypełnianie formularzy.

Jak mogę cyfrowo podpisać dokument PDF przy użyciu API IronSecureDoc?

Możesz cyfrowo podpisać PDF, wysyłając żądanie POST do punktu końcowego `/v1/document-services/pdfs/certify` z plikiem PDF, cyfrowym certyfikatem i hasłem do certyfikatu.

Jakie opcje są dostępne do ochrony dokumentów PDF?

Opcje ochrony PDF obejmują szyfrowanie dokumentu, ustawianie uprawnień dostępu, dodawanie haseł użytkownika i właściciela oraz weryfikację istniejących haseł przy użyciu API IronSecureDoc.

Czy możliwe jest wyodrębnienie tekstu z PDF przy użyciu API IronSecureDoc?

Tak, możesz wyodrębnić tekst z PDF, wysyłając żądanie POST do punktu końcowego `/v1/document-services/pdfs/extract`. Możesz określić parametry, aby wyodrębnić tekst z określonych stron lub całego dokumentu.

Jak mam zweryfikować hasła dokumentu PDF?

Aby zweryfikować hasła, wyślij żądanie POST do punktu końcowego `/v1/document-services/pdfs/verify-password` z plikiem PDF. Dołącz zarówno hasło użytkownika, jak i właściciela do swojego żądania, aby potwierdzić ich ważność.

Jakie są główne możliwości API REST IronSecureDoc?

Główne możliwości API REST IronSecureDoc obejmują sprawdzanie kondycji serwera, weryfikację licencji, redagowanie tekstu, stosowanie podpisów cyfrowych, szyfrowanie PDF i wyodrębnianie tekstu.

Curtis Chau
Curtis Chau
  Czat z zespołem inżynierów teraz
Autor tekstów technicznych

Curtis Chau posiada tytuł licencjata z informatyki (Uniwersytet Carleton) i specjalizuje się w front-endowym rozwoju, z ekspertką w Node.js, TypeScript, JavaScript i React. Pasjonuje się tworzeniem intuicyjnych i estetycznie przyjemnych interfejsów użytkownika, Curtis cieszy się pracą z nowoczesnymi frameworkami i tworzeniem dobrze zorganizowanych, atrakcyjnych wizualnie podrę...

Czytaj więcej
Gotowy, aby rozpocząć?
Wersja: 2024.10 właśnie wydany
Still Scrolling Icon

Wciąż przewijasz?

Czy chcesz szybko dowodu?
uruchom przykład zobacz, jak twój PDF staje się zaszyfrowany.