You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+58-3Lines changed: 58 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,10 +4,62 @@ PDF Generator API allows you easily generate transactional PDF documents and red
4
4
5
5
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.
6
6
7
+
You can find our previous API documentation page with references to Simple and Signature authentication [here](https://docs.pdfgeneratorapi.com/legacy).
8
+
9
+
## Base URL
10
+
The base URL for all the API endpoints is `https://us1.pdfgeneratorapi.com/api/v3`
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](https://support.pdfgeneratorapi.com).
*[Expression Language documentation](https://support.pdfgeneratorapi.com/en/category/expression-language-q203pa/)
21
+
*[Frequently asked questions and answers](https://support.pdfgeneratorapi.com/en/category/qanda-1ov519d/)
22
+
23
+
## Definitions
24
+
25
+
### Organization
26
+
Organization is a group of workspaces owned by your account.
27
+
28
+
### Workspace
29
+
Workspace contains templates. Each workspace has access to their own templates and organization default templates.
30
+
31
+
### Master Workspace
32
+
Master Workspace is the main/default workspace of your Organization. The Master Workspace identifier is the email you signed up with.
33
+
34
+
### Default Template
35
+
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.
36
+
37
+
### Data Field
38
+
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.
39
+
```
40
+
{
41
+
"documentNumber": 1,
42
+
"paymentDetails": {
43
+
"method": "Credit Card",
44
+
"buyerName": "John Smith"
45
+
},
46
+
"items": [
47
+
{
48
+
"id": 1,
49
+
"name": "Item one"
50
+
}
51
+
]
52
+
}
53
+
```
54
+
55
+
* * * * *
7
56
# Authentication
8
57
The PDF Generator API uses __JSON Web Tokens (JWT)__ to authenticate all API requests. These tokens offer a method to establish secure server-to-server authentication by transferring a compact JSON object with a signed payload of your account’s API Key and Secret.
9
58
When authenticating to the PDF Generator API, a JWT should be generated uniquely by a __server-side application__ and included as a __Bearer Token__ in the header of each request.
10
59
60
+
## Legacy Simple and Signature authentication
61
+
You can find our legacy documentation for Simple and Signature authentication [here](https://docs.pdfgeneratorapi.com/legacy).
You can create a temporary token in [Account Settings](https://pdfgeneratorapi.com/account/organization) 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__.
73
125
You can also use [jwt.io](https://jwt.io/) to generate test tokens for your API calls. These test tokens should never be used in production applications.
126
+
* * * * *
74
127
75
128
# Libraries and SDKs
76
129
## Postman Collection
77
-
We have created a [Postman](https://www.postman.com) Collection so you can easily test all the API endpoints wihtout developing and code. You can download the collection [here](https://app.getpostman.com/run-collection/8f99146f64819f3e6db5) or just click the button below.
130
+
We have created a [Postman](https://www.postman.com) Collection so you can easily test all the API endpoints wihtout developing and code. You can download the collection [here](https://app.getpostman.com/run-collection/329f09618ec8a957dbc4) or just click the button below.
78
131
79
-
[](https://app.getpostman.com/run-collection/8f99146f64819f3e6db5)
132
+
[](https://app.getpostman.com/run-collection/329f09618ec8a957dbc4)
80
133
81
134
## Client Libraries
82
135
All our Client Libraries are auto-generated using [OpenAPI Generator](https://openapi-generator.tech/) which uses the OpenAPI v3 specification to automatically generate a client library in specific programming language.
@@ -88,11 +141,12 @@ All our Client Libraries are auto-generated using [OpenAPI Generator](https://op
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
Copy file name to clipboardExpand all lines: docs/Template.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
7
7
**id** | **int** | Unique identifier | [optional]
8
8
**name** | **str** | Template name | [optional]
9
9
**owner** | **bool** | Indicates if the workspace is the owner of the template | [optional]
10
-
**modified** | **datetime** | Timestamp when the template was modified | [optional]
10
+
**modified** | **str** | Timestamp when the template was modified | [optional]
11
11
**tags** | **list[str]** | A list of tags assigned to a template | [optional]
12
12
13
13
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
Copy file name to clipboardExpand all lines: docs/TemplatesApi.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -426,7 +426,7 @@ This endpoint does not need any parameter.
426
426
[[Back to top]](#)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to Model list]](../README.md#documentation-for-models)[[Back to README]](../README.md)
0 commit comments