Prerequisites
What you need before rendering PDFs with the Tuix PDF Service.
Before rendering a PDF you need:
- A Tuix account to access the dashboard.
- An Application ID and a Template ID from the Tuix dashboard.
- An API key from the Tuix dashboard. See API Keys.
- The API base URL (see below).
Base URL
All requests go to:
The examples in these docs read that host from API_BASE_URL.
Finding your IDs
You need two IDs from the dashboard: an Application ID and a Template ID.
Application ID
The Application ID identifies your application and is part of the render path
(/api/applications/{applicationId}/pdf-files).
In the dashboard, open Applications: the Application ID column shows the ID, with a copy icon next to it.
Template ID
The Template ID identifies the template to render. Open an application's templates: the Template ID column shows the ID, with a copy icon next to it.
Authentication
Authentication uses an API key, sent in the x-api-key header:
An API key grants full access to the API. Keep it on the server, never expose it to the browser or ship it in client bundles. To render from a frontend app, proxy the call through your own backend, see Call it from another service.
A request without an API key answers 401 Unauthorized; a request with an
unknown key answers 403 Forbidden.