API Documentation
The PDFGate API provides a set of HTTP endpoints for working with PDF documents, with a focus on digital signatures. You can sign documents and manage document workflows, along with generating PDFs from HTML or URLs and processing existing files.
All requests are authenticated using an API key and return JSON responses using standard HTTP status codes.
PDFGate offers a sandbox environment for testing your integration without affecting production data. The environment is determined by the request URL, and your API key must match the selected environment.
Each request operates on a single document or resource.
Authentication
All API requests must be authenticated using an API key. Authentication is handled via the Authorization header in your HTTP requests.
To get started, log in to your PDFGate account and create an API key from the Settings page in the dashboard. Ensure the key is active before using it in your code.
PDFGate supports two types of API keys:
Use sandbox keys for testing purposes and production keys in your live environment.
Rate limits
The PDFGate API uses different rate limits for each account type in the production environment. In the sandbox environment, the rate limits are the same for all account types.
- Personal: 3
- Starter: 3
- Basic: 5
- Professional: 10
- Professional Plus: 20
- Personal: 2
- Starter: 2
- Basic: 2
- Professional: 2
- Professional Plus: 2
- Personal: 40
- Starter: 50
- Basic: 100
- Professional: 150
- Professional Plus: 200
Errors
The PDFGate API uses standard HTTP status codes to indicate whether a request was successful or failed. Error responses include a message and additional details to help identify and resolve the issue.
If a request fails, review the response body for error information and ensure your request parameters, authentication, and API usage are correct.