REST API for IronSecureDoc in C#
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:
- Check License Key
- Redact PDF Functionality
- Sign PDF Functionality
- Protect PDF Functionality
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
Frequently Asked Questions
What is the purpose of the REST API for IronSecureDoc?
The REST API for IronSecureDoc allows developers to secure and manage documents by providing endpoints for operations such as document redaction, signing, protection, and verification.
How do I check if the IronSecureDoc REST API server is running?
To check if the IronSecureDoc REST API server is running, use the 'GET' Health Check endpoint available at 'http://localhost:8080/v1/document-services/ping'. A successful response will return 'pong'.
How can I verify the validity of my IronSecureDoc license using the REST API?
You can verify the validity of your IronSecureDoc license by using the 'GET' Check License endpoint at 'http://localhost:8080/v1/document-services/check-license'. A successful license check will return 'Valid'.
What is needed to redact text in a PDF using IronSecureDoc's REST API?
To redact text in a PDF using IronSecureDoc's REST API, provide a 'pdf_file' in application/pdf format and an array of 'words_to_redact' as parameters in the POST request to the 'http://localhost:8080/v1/document-services/pdfs/redact-text' endpoint.
Can I apply a digital signature to a PDF using IronSecureDoc?
Yes, IronSecureDoc allows you to apply a digital signature to a PDF using the 'Certify PDF / Apply Digital Signature' functionality available through its REST API endpoints.
How do I protect a PDF with a password via IronSecureDoc's API?
You can protect a PDF by encrypting it or adding a password using the 'Encrypt / Add Password to PDF' functionality via IronSecureDoc's REST API.
Is it possible to verify signatures on a PDF using IronSecureDoc's API?
Yes, IronSecureDoc provides functionality to verify certificates and signatures on PDFs through its REST API using the 'Verify Certificates / Signatures' endpoint.
What are the benefits of using IronSecureDoc's REST API?
Using IronSecureDoc's REST API provides seamless integration into your applications, allowing for automated document management processes such as redacting, signing, encrypting, and verifying documents programmatically.
Can I change PDF permissions using IronSecureDoc?
Yes, IronSecureDoc's REST API allows you to set and change PDF permissions, which is part of its Protect PDF functionality.
What should I do if I encounter issues with placeholder URLs in IronSecureDoc's tutorial?
If you encounter issues with placeholder URLs in IronSecureDoc's tutorial, ensure that you replace 'http://localhost:8080/' with your actual server URL and substitute example values in request URLs with the appropriate data.
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.
