@templafy/delivery-integration-library v1.1.6

Templafy Delivery Integration Library

This library was created to allow external vendors to integrate custom delivery options for documents created within Templafy. This will allow Templafy users to authenticate with, choose a save location in, and save created documents directly to an external system.

Usage

A delivery integration always consists of two parts.

• Delivery Connector
  A page hosted within an iframe on the delivery step of a Templafy document creation flow. This can be used to ask the user for additional input and to execute logic to save the document to a custom location.

• Authentication popup
  A pop-up that points to a custom sign-in URL. This can be used to ask the user to login and is able to pass some arbitrary state to the Delivery Connector.

Examples can be found under Examples

Caveats

All content must be served over HTTPS.

Authentication popup

• The popup must start on a URL from the same origin as the Connector.
• The SendAuthenticationComplete call must come from the same origin as the popup was opened at.

Delivery Connector

• The Delivery Connector will be hosted in an iframe with sandbox attribute value allow-scripts allow-forms allow-same-origin.
• The Connector will be hosted on a page with the CSP directive frame-src set to the origin of the BaseURL specified in your Custom Delivery Integration settings. This means that the connector cannot navigate outside of the original origin.