Skip to content
Documentation menu

Quickstart

From a new account to your first PDF rendered through the API: connect, query, design, publish, render.

This guide takes you from a new account to a PDF rendered through the API in a few minutes, without connecting any database: the sample gallery has ready-made templates (delivery note, invoice, order confirmation, quote, packing list, account statement, price list, product sheet, GS1 shipping label in ZPL, a business letter) that read built-in demo data. Then you point a template to your own database.

  1. Create an account

    Create an account, open the verification link we email you, then sign in. Create your organization (a free trial, or your license key) and its first workspace: it starts with three environments (development, staging and production); the Designer works on development, where you can experiment freely.

  2. Start from a sample

    The onboarding offers Start with a sample; later you find the gallery in Templates → Start from a sample (also from New template). Each sample shows a thumbnail, what it demonstrates and its parameters. Use this sample copies it into your workspace as a draft template, with the company header component and the logo it uses, and opens it in the Designer. The copy is yours: the gallery never changes it.

    Built-in demo data

    Sample datasets read the data source PRYNT_DEMO: a read-only demo database of a fictitious apparel company (customers, orders, delivery notes, invoices, products, shipments), the same for every workspace and never mixed with your data. Nothing to configure.

  3. Preview it

    Press Preview (F5): the PDF is generated with the test value of each parameter, for example DOCUMENT_ID = 82422 for the delivery note. Change the value in the preview panel to see another document. ZPL labels have their own preview, drawn as the printer would print them.

  4. Publish

    Publish validates the template and creates version 1, which can no longer change, and the current version: the API renders it from the next request, in every environment. To change the document later, create a new draft and publish again. Members with the designer role see Request publication instead: a developer, admin or owner approves it in Publish requests.

  5. Create an API key

    In Developers → API keys, create a key (a test key for development). The full key is shown once: store it as a secret in your application's configuration, never in browser code or in source control.

  6. Render the document

    Call the render endpoint with the template code and its parameters. The response body is the PDF.

    Terminal
    curl -X POST https://api.prynt.it/api/v1/render \  -H "Authorization: Bearer prynt_live_..." \  -H "Content-Type: application/json" \  -d '{    "template": "invoice",    "environment": "production",    "parameters": { "invoiceId": 18425 }  }' \  -o invoice-18425.pdf

    A successful call answers 200 OK with Content-Type: application/pdf. Failures answer with a problem document; see errors. The workspace Overview has a Get started checklist that follows these steps, with this request ready to copy for your template (cURL, C#, JavaScript) and a Try it button that downloads the PDF.

  7. Connect your database

    In Data sources, choose New data source, give it a name and a code, and choose Oracle (or PostgreSQL). Then configure the connection of the development environment: a Prynt Gateway for a database on a private network (download it from the Download Center), or a direct connection over TLS for a cloud database; host, port and service name (the database name for PostgreSQL), and the credentials of a user that can read the tables your documents need. Save connection saves and tests it.

    Oracle · recommended read-only user
    -- A dedicated, read-only user for PryntCREATE USER prynt_reader IDENTIFIED BY "<a strong password>";GRANT CREATE SESSION TO prynt_reader;GRANT SELECT ON erp.invoices      TO prynt_reader;GRANT SELECT ON erp.invoice_lines TO prynt_reader;GRANT SELECT ON erp.customers     TO prynt_reader;

    Credentials stay protected

    Passwords are encrypted at rest and never sent back to the browser. Datasets can only read: statements that modify data are refused.

  8. Point the template to your data

    Open the template in the Designer and, for each dataset, choose your data source instead of PRYNT_DEMO in the dataset toolbar. Rewrite the query on your tables keeping the same column names with aliases (the layout reads the fields by name), run it to refresh the fields and check the parameters: the sample datasets bind the company to the constant 01 of the demo data, bind it to your own parameter or to the system value DITTA. Preview with real documents, then publish a new version.

    A dataset on your own tables
    SELECT i.invoice_no, i.issue_date, c.name AS customer_name,       l.description, l.quantity, l.amount  FROM erp.invoices i  JOIN erp.customers c      ON c.id = i.customer_id  JOIN erp.invoice_lines l  ON l.invoice_id = i.id WHERE i.id = :invoiceId ORDER BY l.line_no

  9. Design your own templates

    For a document of your own, New template creates a blank one (format Document (PDF) or ZPL label): add a dataset (every bind variable such as :invoiceId becomes a parameter), drag its fields onto the page, add tables, totals, a logo and barcodes, and preview at any time.

Next steps