Articles in this section

What is the Templafy Public API?

The Templafy Public API is the gateway for other applications to interact with Templafy. It can be used to automate actions that otherwise would need to be done manually, for example uploading/synchronizing/deleting templates and assets in the Library, maintaining data sources, or generating documents.

  Prerequisites

Use cases examples

Automatic synchronization with the Library

The ability to automatically synchronize external applications with Templafy bares a broad variety of use-cases:

  • Synchronizing DAM with Templafy: Automatically synchronizing images, templates & assets between an external DAM system and Templafy eliminates the necessity for the admin to manually upload the files.
  • Automatic upload of slides on a daily basis: When companies have the need to upload slides daily for the purpose of keeping prices and like up to date this can be automated using the API.
  • Automatic upload after approval: If companies have internal approval processes for new content such as slides, our API can help upload these pieces of content automatically once the last approval has been given.

Maintain and replicate data sources

The ability to maintain and replicate data sources with Templafy bares a broad variety of use-cases:

  • Creating a new data source: Create a data source from internal systems (such as HR platforms, CMS and others) without having to manually enter the data in Templafy Admin Center.
  • Updated company data everywhere: Synchronize data from internal systems (such as HR platforms, CMS and others) and Templafy data sources to ensure that the company data is always up to date. This allows to edit the data in internal systems or in Templafy while being ensured that both systems are updated.
  • Synchronize the data sources between tenants: Creating the possibility of duplicating the data sources from one tenant to another in a simple way, smoothing the process of replicating data sources to cater for the creation of UAT tenants, test tenants, multi-brands.

Unattended Document generation 

The ability to leverage unattended document generation with Templafy allows to support the following use case:

  • Generating a document without interacting with the Templafy interface: Create the possibility of automating document creation by removing the need for users to interact with the Templafy interface to create static and dynamic documents.

Public API Documentation

You can access the full Public API documentation here: https://api.templafy.com/.

How to generate a token to interact with the Templafy API

In order to interact with the API, you must create the necessary key in Templafy Admin Center

  1. Navigate to the account section.
  2. In the API Keys tab, click Create key.
  3. Provide a name to the key.
  4. Click Next.
  5. Click Add scope and select scopes based on your needs: 
    • library.read to surface Templafy content.
      All GET actions in Documents, EmailElements, Folders, Images, Libraries, Links, PDFs, Presentations, SlideElements, Slides, Spreadsheets, and TextElements.
    • library.readwrite to interact with Templafy content.
      All actions in Documents, EmailElements, Folders, Images, Libraries, Links, PDFs, Presentations, SlideElements, Slides, Spreadsheets, and TextElements.
    • library.generate to generate Templafy documents (Documents, Presentations, Spreadsheets).
      POST actions with /generate endpoint in Documents, Presentations, Spreadsheets.
    • datasources.read to surface the data sources.
      All GET actions in DataSourceItems and DataSources.
    • datasources.readwrite to interact with the data sources.
      All actions in DataSourceItems and DataSources.
    • spaces.read to surface list of Templafy spaces.
      GET action in Spaces.
  6. Click Create.
  7. Click Copy key.

  Important

  • The API keys are unique keys and are non-recoverable. If you lose a key you will have to regenerate a new key.
  • The name of a key cannot be edited after its creation.
Salesforce tech_role
Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Article is closed for comments.