Templafy API (Hive)

About this article

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

• Use cases examples
• Swagger API
• How to generate a token to interact with the Templafy API? 

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

• 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
• 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...
• ...

Swagger documentation

You can access the swagger documentation from this link: https://api.templafy.com/?urls.primaryName=Templafy%20Public%20API%20v2%20(preview) 

How to generate a token to interact with the Templafy API? 

In order to interact with the API, one 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 
   • library.read to surface Templafy content
     All GET actions in Documents, EmailElements, Folders, Images, Libraries, Links, PDFs, Presentations, SlideElements, Slides, Spreadsheets, and TextElements  but /libraries/{libraryId}/assets/upload-url
     
     
   • library.readwrite to interact with Templafy
     All actions in Documents, EmailElements, Folders, Images, Libraries, Links, PDFs, Presentations, SlideElements, Slides, Spreadsheets, and TextElements
     
     
   • 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
     
     
6. Click Create
7. Click Copy key

Related articles