Mock sample for your project: PDF Generator API
Integrate with "PDF Generator API" from pdfgeneratorapi.com in no time with Mockoon's ready to use mock sample
PDF Generator API
Version: 3.1.1
Integrate third-party APIs faster by using "PDF Generator API" ready-to-use mock sample. Mocking this API will help you accelerate your development lifecycles and improves your integration tests' quality and reliability by accounting for random failures, slow response time, etc.
It also helps reduce your dependency on third-party APIs: no more accounts to create, API keys to provision, accesses to configure, unplanned downtime, etc.
Description
Introduction
PDF Generator API allows you easily generate transactional PDF documents and reduce the development and support costs by enabling your users to create and manage their document templates using a browser-based drag-and-drop document editor.
The PDF Generator API features a web API architecture, allowing you to code in the language of your choice. This API supports the JSON media type, and uses UTF-8 character encoding.
You can find our previous API documentation page with references to Simple and Signature authentication here.
Base URL
The base URL for all the API endpoints is https://us1.pdfgeneratorapi.com/api/v3
For example
https://us1.pdfgeneratorapi.com/api/v3/templates
https://us1.pdfgeneratorapi.com/api/v3/workspaces
https://us1.pdfgeneratorapi.com/api/v3/templates/123123
Editor
PDF Generator API comes with a powerful drag & drop editor that allows to create any kind of document templates, from barcode labels to invoices, quotes and reports. You can find tutorials and videos from our Support Portal.
Component specification
Expression Language documentation
Frequently asked questions and answers
Definitions
Organization
Organization is a group of workspaces owned by your account.
Workspace
Workspace contains templates. Each workspace has access to their own templates and organization default templates.
Master Workspace
Master Workspace is the main/default workspace of your Organization. The Master Workspace identifier is the email you signed up with.
Default Template
Default template is a template that is available for all workspaces by default. You can set the template access type under Page Setup. If template has "Organization" access then your users can use them from the "New" menu in the Editor.
Data Field
Data Field is a placeholder for the specific data in your JSON data set. In this example JSON you can access the buyer name using Data Field {paymentDetails::buyerName}. The separator between depth levels is :: (two colons). When designing the template you don’t have to know every Data Field, our editor automatically extracts all the available fields from your data set and provides an easy way to insert them into the template.
Testing with JWTs
You can create a temporary token in Account Settings page after you login to PDF Generator API. The generated token uses your email address as the subject (sub) value and is valid for 5 minutes.
You can also use jwt.io to generate test tokens for your API calls. These test tokens should never be used in production applications.
Libraries and SDKs
Postman Collection
We have created a Postman Collection so you can easily test all the API endpoints wihtout developing and code. You can download the collection here or just click the button below.
Run in Postman
Client Libraries
All our Client Libraries are auto-generated using OpenAPI Generator which uses the OpenAPI v3 specification to automatically generate a client library in specific programming language.
PHP Client
Java Client
Ruby Client
Python Client
Javascript Client
We have validated the generated libraries, but let us know if you find any anomalies in the client code.
Error codes
| Code | Description |
|--------|--------------------------------|
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 422 | Unprocessable Entity |
| 500 | Internal Server Error |
401 - Unauthorized
| Description |
|-------------------------------------------------------------------------|
| Authentication failed: request expired |
| Authentication failed: workspace missing |
| Authentication failed: key missing |
| Authentication failed: property 'iss' (issuer) missing in JWT |
| Authentication failed: property 'sub' (subject) missing in JWT |
| Authentication failed: property 'exp' (expiration time) missing in JWT |
| Authentication failed: incorrect signature |
403 - Forbidden
| Description |
|-------------------------------------------------------------------------|
| Your account has exceeded the monthly document generation limit. |
| Access not granted: You cannot delete master workspace via API |
| Access not granted: Template is not accessible by this organization |
| Your session has expired, please close and reopen the editor. |
404 Entity not found
| Description |
|-------------------------------------------------------------------------|
| Entity not found |
| Resource not found |
| None of the templates is available for the workspace. |
422 Unprocessable Entity
| Description |
|-------------------------------------------------------------------------|
| Unable to parse JSON, please check formatting |
| Required parameter missing |
| Required parameter missing: template definition not defined |
| Required parameter missing: template not defined |
Other APIs in the same category
Barcode API
Name Generation API
PDF Generator API
PDF Generator API allows you easily generate transactional PDF documents and reduce the development and support costs by enabling your users to create and manage their document templates using a browser-based drag-and-drop document editor.
The PDF Generator API features a web API architecture, allowing you to code in the language of your choice. This API supports the JSON media type, and uses UTF-8 character encoding.
You can find our previous API documentation page with references to Simple and Signature authentication here.
Base URL
The base URL for all the API endpoints is https://us1.pdfgeneratorapi.com/api/v3
For example
https://us1.pdfgeneratorapi.com/api/v3/templates
https://us1.pdfgeneratorapi.com/api/v3/workspaces
https://us1.pdfgeneratorapi.com/api/v3/templates/123123
Editor
PDF Generator API comes with a powerful drag & drop editor that allows to create any kind of document templates, from barcode labels to invoices, quotes and reports. You can find tutorials and videos from our Support Portal.
Component specification
Expression Language documentation
Frequently asked questions and answers
Definitions
Organization
Organization is a group of workspaces owned by your account.
Workspace
Workspace contains templates. Each workspace has access to their own templates and organization default templates.
Master Workspace
Master Workspace is the main/default workspace of your Organization. The Master Workspace identifier is the email you signed up with.
Default Template
Default template is a template that is available for all workspaces by default. You can set the template access type under Page Setup. If template has "Organization" access then your users can use them from the "New" menu in the Editor.
Data Field
Data Field is a placeholder for the specific data in your JSON data set. In this example JSON you can access the buyer name using Data Field {paymentDetails::buyerName}. The separator between depth levels is :: (two colons). When designing the template you don’t have to know every Data Field, our editor automatically extracts all the available fields from your data set and provides an easy way to insert them into the template.
Testing with JWTs
You can create a temporary token in Account Settings page after you login to PDF Generator API. The generated token uses your email address as the subject (sub) value and is valid for 5 minutes.
You can also use jwt.io to generate test tokens for your API calls. These test tokens should never be used in production applications.
Libraries and SDKs
Postman Collection
We have created a Postman Collection so you can easily test all the API endpoints wihtout developing and code. You can download the collection here or just click the button below.
Run in Postman
Client Libraries
All our Client Libraries are auto-generated using OpenAPI Generator which uses the OpenAPI v3 specification to automatically generate a client library in specific programming language.
PHP Client
Java Client
Ruby Client
Python Client
Javascript Client
We have validated the generated libraries, but let us know if you find any anomalies in the client code.
Error codes
| Code | Description |
|--------|--------------------------------|
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 422 | Unprocessable Entity |
| 500 | Internal Server Error |
401 - Unauthorized
| Description |
|-------------------------------------------------------------------------|
| Authentication failed: request expired |
| Authentication failed: workspace missing |
| Authentication failed: key missing |
| Authentication failed: property 'iss' (issuer) missing in JWT |
| Authentication failed: property 'sub' (subject) missing in JWT |
| Authentication failed: property 'exp' (expiration time) missing in JWT |
| Authentication failed: incorrect signature |
403 - Forbidden
| Description |
|-------------------------------------------------------------------------|
| Your account has exceeded the monthly document generation limit. |
| Access not granted: You cannot delete master workspace via API |
| Access not granted: Template is not accessible by this organization |
| Your session has expired, please close and reopen the editor. |
404 Entity not found
| Description |
|-------------------------------------------------------------------------|
| Entity not found |
| Resource not found |
| None of the templates is available for the workspace. |
422 Unprocessable Entity
| Description |
|-------------------------------------------------------------------------|
| Unable to parse JSON, please check formatting |
| Required parameter missing |
| Required parameter missing: template definition not defined |
| Required parameter missing: template not defined |
Fun Generators API
UUID Generation API
Asynchronous Speech-To-Text API Documentation
For a real-time speech to text solution, use Rev.ai's Streaming API.
Base Endpoint
The base url for this version of the API is
> https://api.rev.ai/speechtotext/v1
All endpoints described in this documentation are relative to this base url.
Quick Start
Follow the getting started checklist
Get your Access Token
You can generate your access token on the settings page of your account. This access token only needs to be generated once and never expires. You can re-generate your token, however this will invalidate the previous token.
Submit a File
To submit an audio file for transcription to Rev.ai:
Retrying Failed Requests
Some errors can be resolved simply by retrying the request. The following error codes are likely to be resolved with successive retries.
| Status Code | Error |
|---|:---|
| 429 | Too Many Requests |
| 502 | Bad Gateway |
| 503 | Service Unavailable |
| 504 | Gateway Timeout |
Note: With the exception of the 429 status code, it is recommended that the maximum number of retries be limited to 5 attempts per request. The number of retries can be higher
for 429 errors but if you notice consistent throttling please contact us at.
ocrapi
PDF Blocks API
NamSor API v2
Geneea Natural Language Processing
For all calls, supply your API key. Sign up to obtain the key .
Our API supports both unencrypted (HTTP) and encrypted (HTTPS) protocols.
However, for security reasons, we strongly encourage using only the encrypted version.
The API key should be supplied as either a request parameter user_key or in Authorization header.
Authorization: user_key
API operations
All API operations can perform analysis on supplied raw text or on text extracted from a given URL.
Optionally, one can supply additional information which can make the result more precise. An example
of such information would be the language of text or a particular text extractor for URL resources.
The supported types of analyses are:
lemmatization ⟶
Finds out lemmata (basic forms) of all the words in the document.
correction ⟶
Performs correction (diacritization) on all the words in the document.
topic detection ⟶
Determines a topic of the document, e.g. finance or sports.
sentiment analysis ⟶
Determines a sentiment of the document, i.e. how positive or negative the document is.
named entity recognition ⟶
Finds named entities (like person, location, date etc.) mentioned the the document.
Encoding
The supplied text is expected to be in UTF-8 encoding, this is especially important for non-english texts.
Returned values
The API calls always return objects in serialized JSON format in UTF-8 encoding.
If any error occurs, the HTTP response code will be in the range 4xx (client-side error) or
5xx (server-side error). In this situation, the body of the response will contain information
about the error in JSON format, with exception and message values.
URL limitations
All the requests are semantically GET. However, for longer texts, you may run into issues
with URL length limit. Therefore, it's possible to always issue a POST request with all
the parameters encoded as a JSON in the request body.
Example:
POST /s1/sentiment
Content-Type: application/json
{"text":"There is no harm in being sometimes wrong - especially if one is promptly found out."}
This is equivalent to GET /s1/sentiment?text=There%20is%20no%20harm...
Request limitations
The API has other limitations concerning the size of the HTTP requests. The maximum allowed size of any
POST request body is 512 KiB. For request with a URL resource, the maximum allowed number of
extracted characters from each such resource is 100,000.
Terms of Service
By using the API, you agree to our
Terms of Service Agreement.
More information
The Interpretor Public Documentation