HotDocs Embedded API Overview
The HotDocs Embedded API allows you to create and embed a HotDocs Interview in a web page, using a single web service call.
Embedded Interview JavaScript Files
See Embedded Interview JavaScript File Locations for information about the JavaScript files required to use embedded interviews.
HotDocs Embedded API
Methods
Name | Verb | URL | Description |
New Session | POST | https://{subscribedEndpoint}/embed/newsession/{subscriberID}/{packageID} | Create a new Embedded Interview Session using Cloud Services. |
Resume Session | POST | https://{subscribedEndpoint}/embed/resumesession/{subscriberID}/{packageID} | Resume a preview Session from a Snapshot. |
Embedded JavaScript API
For information about the client-side API, see the Embedded JavaScript API.
Walkthrough
For instructions on using the Embedded API, see the Embedded API Tutorials:
- Display an Interview using the Cloud Services Embedded API
- Resume an Interview
- Using the Embedded JavaScript API
Styling the Embedded Interview
See Using Themes for Embedded Interviews for information about customizing the appearance of embedded interviews.