Templafy Public API V2

This article contains the release notes for the second stable version of Templafy Public API.

Released to Stable in December 2023

The following endpoints and related functionality were delivered as a part of the second stable version.

Templates and assets

For Documents, Spreadsheet, Presentation, and Text element libraries the following was added:

• POST to generate a compiled document based on the template:
  • With a valid email address, the system will look for the default user profile related to the user. If not valid the endpoint returns 401 error.
  • If template does not exist, the endpoint returns 404 error.
  • The support to produce a PDF file together with the Office file (not supported for Text elements assets).
  • The endpoint can receive external data that will be injected into the pipeline under Host system identifier.

Resources

A set of endpoints to manipulate data sources, data source fields, data source items and data source item fields.

Data sources

This set of endpoints enables manipulation of data sources. There is a possibility to retrieve one or more data sources, and to create, update or delete a data source.

• GET a list of all data sources and the schema of their fields.
• GET a single data source and the schema of its fields.
• POST endpoint to create a new data source using the submitted field schema. This endpoint is polymorphic as it accepts different properties based on the data source field type (text, number, image, reference). Each data source needs to have a unique name. A single tenant can have up to a 1000 data sources.
• PATCH endpoint to update a single data source.
• DELETE endpoint to delete an existing data source.

Data source fields

This set of endpoints enables manipulation of data source fields within an existing data source.

• GET a schema of a single field from an existing data source.
• POST endpoint to create a new field within an existing data source. Also a polymorphic endpoint, accepting details about text, number, image or reference field. A single data source can have up to a 300 fields.
• PATCH endpoint to update a single data source field.
• DELETE endpoint to delete an existing data source field.

Data source items

These endpoints provide a functionality to manipulate items of a data source.

• GET a list of all data source items from an existing data source using paging.
• GET a single data source item from an existing data source.
• POST endpoint to create a new data source item within an existing data source. A polymorphic endpoint, supporting text, number, image, reference, color theme and font field types. A single data source can have up to a 50000 items.
• PATCH endpoint to update a data source item. Also polymorphic, supports same field types as POST endpoint.
• DELETE endpoint to delete an existing data source item.

Data source item fields

These 2 endpoints help with manipulating individual fields of a data source item.

• PUT endpoint to update a single field on an existing data source item. A polymorphic endpoint, supporting text, number, image, reference, color theme and font field types.
• DELETE endpoint to delete a single data source item field.