Embedded Processes SDK

Article Overview

The following article describes how to embed EasySend processes with a Software Development Kit (SDK), to operate within your website or web-based applications.

Why use the SDK?

(See Figure 1 and Figure 2)

The SDK enables your developers to seamlessly embed EasySend processes within your website or web-based applications to operate smoothly with a native look that matches your brand.

The SDK contains a script that can be implemented inside every website or web-based application. Once the SDK is imported to the webpage it is possible to:

• Preload processes, to optimize their loading time
• Open Processes inside an Iframe embedded in websites
• Monitor process events
• Configure prefilled data (requires an API key)

Figure 1: Embedded Process

Figure 2: Not Embedded Process

Technical Requirements

• Update your environment servers to version 31.2.0 or above
• Download the zip file and perform the following steps:

• • Extract the files
  • Open the index.html file
  • follow the instructions

• Provide EasySend with the URL/s in which the SDK will be implemented, to enable it on your environment servers

•  For the inner (Iframe) component where the process is embedded, use a sub-domain of the outer (host) components. For example, “easysend.app” can potentially include process.easysend.app as an inner frame

Design Guidelines and Implementation Limitations

• Process page headers should be removed
• The Call To Action (CTA) should be placed in a visible area without requiring scrolling (above the fold)
• Forms should be relatively short and simple, for example, 101 form, get a quote request, FNOL
• Each page should contain a limited number of fields to fill out, typically between two to five
• Certain built-in functionalities like Co-Browsing or save and continue later may not function correctly
• Pop-up elements may appear unusual or out of place within the design
• Embedding processes into other pages is only feasible for processes with a single step or the initial step of a process
• It’s recommended to adjust the theme - buttons, page layout, a page with height, no header, to suit the specific requirements of each customer
• Welcome pages may not be necessary and can be replaced with informative titles for better user experience
• Data might be lost when navigating to a different location on the website (since a new RID is generated every time)