1. IronSecureDoc
  2. Tutorials
  3. REST API for IronSecureDoc

REST API for IronSecureDoc in C

Curtis Chau
Curtis Chau
Updated:

This is the REST API Reference for your instance of IronSecureDoc. This tutorial assumes you already have a container instance running. If you are looking to Get Started please follow our Guide.

Jump to features:

Tips

  • The placeholder of http://localhost:8080/ will be used for the URL in all examples. Please ensure you replace it with your URL.
  • Make sure to replace the placeholder values (e.g., path/to/your/file.pdf, certificate_password, etc.) with actual values.
  • The author, title, and subject headers are included in all request examples.

[GET] Health Check

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

Health check endpoint to verify that the server is running.

Response: 200 OK: pong

[GET] Check License

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

Verifies the validity of the license.

Response: 200 OK: Valid

[POST] Redact Text

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

Hides sensitive words in a PDF format document using true redaction. Include a PDF file as a pdf_file object in the request body.

Required Request Body Parameters

NameData TypeDescription
`pdf_file`application/pdf fileThe PDF file to redact.
`words_to_redact`array[string]An array of words to be redacted from the document.

Frequently Asked Questions

What is the purpose of the IronSecureDoc REST API?

The IronSecureDoc REST API is designed to help developers secure and manage PDF documents by providing functionalities such as text redaction, digital signature application, document encryption, and password verification.

How can I ensure my server is operational using the IronSecureDoc API?

You can ensure your server is operational by sending a GET request to the `/v1/document-services/ping` endpoint. If successful, the server will respond with a `200 OK` status and the message `pong`.

How do I redact specific text or patterns in a PDF using the API?

You can redact specific text or patterns in a PDF by sending a POST request to the `/v1/document-services/pdfs/redact-text` endpoint with the PDF and the text or regular expressions you wish to redact.

How can I verify if a PDF's digital signatures are valid?

To verify digital signatures in a PDF, you can send a POST request to the `/v1/document-services/pdfs/verify-signatures` endpoint with the PDF file. The API will return information on the validity of each signature.

What steps are involved in encrypting a PDF using the IronSecureDoc API?

To encrypt a PDF, send a POST request to the `/v1/document-services/pdfs/encrypt` endpoint with the PDF file, specifying user and owner passwords and any permissions you wish to set, such as content extraction or form filling.

How can I digitally sign a PDF document using the IronSecureDoc API?

You can digitally sign a PDF by sending a POST request to the `/v1/document-services/pdfs/certify` endpoint with the PDF file, a digital certificate, and the certificate password.

What options are available for protecting PDF documents?

Options for protecting PDFs include encrypting the document, setting access permissions, adding user and owner passwords, and verifying existing passwords using the IronSecureDoc API.

Is it possible to extract text from a PDF using the IronSecureDoc API?

Yes, you can extract text from a PDF by sending a POST request to the `/v1/document-services/pdfs/extract` endpoint. You can specify parameters to extract text from certain pages or the entire document.

How do I verify the passwords of a PDF document?

To verify passwords, send a POST request to the `/v1/document-services/pdfs/verify-password` endpoint with the PDF file. Include both the user and owner passwords in your request to confirm their validity.

What are the main capabilities of the IronSecureDoc REST API?

The main capabilities of the IronSecureDoc REST API include server health checks, license verification, text redaction, digital signature application, PDF encryption, and text extraction.

Curtis Chau
Curtis Chau
  Chat with engineering team now
Technical Writer

Curtis Chau holds a Bachelor’s degree in Computer Science (Carleton University) and specializes in front-end development with expertise in Node.js, TypeScript, JavaScript, and React. Passionate about crafting intuitive and aesthetically pleasing user interfaces, Curtis enjoys working with modern frameworks and creating well-structured, visually appealing manuals.

...

Read More
Ready to Get Started?
Version: 2024.10 just released