Frequently Asked Questions
General API
When you sign up with an account and select a plan, you will receive a unique API Key that will grant you access to send API Calls to any of the pdfRest API Tools. At the start of each calendar month, your total number of API Calls will be tallied for the previous month, and you will be billed for your base plan plus any overage you may have accrued if your monthly API Calls were in excess of your plan's included amount. This count starts over at zero on the first day of each month.
pdfRest supports two types of API Calls:
- POST Requests: These are used to process files with each of the API Tools
- GET Requests: These are used to retrieve files back from the processing server or poll for request status and response
All calls that require your API Key count towards your monthly total, including all POST requests and GET requests sent to the /request-status endpoint. GET requests sent to the /resource endpoint do not require your API Key or count towards your monthly total.
API Lab is your one-stop shop for getting started with pdfRest. It's a web-based interface built directly into the pdfRest website that can be used with free or paid accounts. API Lab allows you to:
- Test and Validate Solutions: Experiment with pdfRest's functionality in real-time. Upload your own files and test different tools and options to see how they work before integrating them into your application. 0 Learn by Doing: Explore the various features and parameters offered by pdfRest. API Lab provides a user-friendly interface to discover the potential of different tools.
- Generate Code: Save valuable development time! Once you've customized your processing options in API Lab, it can automatically generate code snippets in your preferred programming language. Simply copy and paste this code into your project to get started.
Think of API Lab as your personal pdfRest playground – a space to experiment, learn, and streamline your development process.
File Retention Period refers to the duration for which pdfRest stores the uploaded input files and processed output files after an API call completes. This allows you to access or download the converted documents for a specific period.
After this amount of time, files are automatically and permanently deleted for your security. We cannot recover files after they are deleted, so be sure to retrieve them after processing completes. Please refer to the Pricing page for the file retention period for each Plan. This value can be customized for Enterprise plans.
Security and Compliance
api.pdfrest.com and eu-api.pdfrest.com.API Toolkit Cloud customers have access to the same API hosted within Amazon Web Services (AWS) in two regions, the United States and the European Union.
The US-based API at api.pdfrest.com is hosted in AWS's us-east-2 region in Ohio.
The EU-based API at eu-api.pdfrest.com is hosted among the following AWS regions in the EU:
eu-central-1, Germanyeu-west-1, Irelandeu-west-3, Franceeu-north-1, Sweden
Yes, pdfRest API Toolkit Cloud is GDPR compliant when you submit your calls to our EU-hosted API.
We adhere to strict security and privacy standards, including:
- Data Protection: We implement robust security measures to protect your data, including encryption and access controls.
- Data Retention: We follow GDPR's strict data retention policies, ensuring that your data is deleted after the specified file retention period.
- Compliance: We are committed to complying with GDPR and other relevant data protection regulations.
For more detailed information, please refer to our Data Processing Agreement, specifically Appendix C, which outlines our security controls and practices.
Please contact us if you have any further questions relating to GDPR compliance or our security practices.
The pdfRest Cloud service offers a dedicated EU GDPR API for organizations requiring data processing within the European Union to comply with GDPR regulations. Here's how it works:
Dedicated EU Endpoint
- To ensure your data remains within the EU, you must direct your API requests to our dedicated EU endpoint:
eu-api.pdfrest.com - Requests sent to our standard US endpoint
api.pdfrest.comwill result in data being processed within the United States, which may not meet your GDPR compliance requirements.
Simple Endpoint Changes
- All of our existing PDF processing tools are available through the EU endpoint.
- You simply need to change the root URL of your API requests, while keeping the endpoint paths the same.
- For example, to compress a PDF, use
eu-api.pdfrest.com/compressed-pdf.
Data Processing Within the EU
- Using the EU endpoint guarantees that all data uploads, processing, and storage occur exclusively within our secure EU data centers.
- This ensures adherence to GDPR data protection laws and minimizes the risk of non-compliance.
Data Processing Agreement (DPA)
- We provide a Data Processing Agreement (DPA), a legally binding contract outlining our responsibilities and obligations regarding personal data processing.
- This DPA demonstrates our commitment to GDPR compliance and provides transparency into our data processing practices.
Plan Level Access and Pricing
- Premium and Pro plans have a fee associated with each call to the GDPR-compliant API. There is no fee for Enterprise usage. Please refer to the Pricing page for more details.
All production systems are ephemeral and utilize infrastructure-as-code practices. There is currently no need for backups of our systems.
The duration that customer files are stored depends on the customer's selected plan level. This duration is determined by the "File Persistence" value associated with each plan, which is displayed in detail on the Pricing page. pdfRest adheres to a file lifecycle policy that automatically deletes files after the designated File Persistence period has elapsed.
No customer data is retained or backed up beyond that File Persistence period.
Features and Pricing
See the FAQ on the Pricing page for any pricing-related questions. Reach out to pdfRest Support with any additional inquiries.