Integration Examples
Walkthroughs and code examples are available to help developers use the HotDocs APIs with their own applications.
Example Source Code on GitHub
Each walkthrough has a corresponding example project available on GitHub, in the HotDocs-Samples repository.
HotDocs Cloud Services
HotDocs Cloud Services provides the document assembly features of HotDocs Server in a hosted cloud platform. The walkthroughs below provides instructions on developing against the Cloud Services REST API.
| Walkthrough | Description | Example Project (GitHub) |
| Upload a Template Package | Upload a HotDocs Template Package File to Cloud Services using the Cloud Services REST API. | CloudServicesAPIExample1Upload |
| Assemble a Document | Assemble a completed document using the Cloud Services REST API and the uploaded Template Package File. | CloudServicesAPIExample2DocumentAssembly |
| Display an Interview | Display an interview in a web page using the Cloud Services REST API. | CloudServicesAPIExample3Interview |
| Read Variable and Dialog Information from the Component File | Read information about the Variable and Dialog components from the Template Package File uploaded to Cloud Services, using the Cloud Services REST API. | CloudServicesAPIExample4ComponentInfo |
| Get Interview File | Get individual files from the Template Package File uploaded to Cloud Services, using the Cloud Services REST API. | CloudServicesAPIExample5InterviewFile |
Embedded API
The HotDocs Cloud Services Embedded Interview allows you to display a HotDocs Interview in an IFrame emedded in a web page. By using an Embedded Interview, you can display interviews to users with a small amount of development effort.
| Walkthrough | Description | Example Project (GitHub) |
| Display an Interview | Display an interview in an IFRAME, using the Cloud Services Embedded API. | CloudServicesEmbeddedAPIExample |
| Resume an Interview | Save and resume a previous interview session, using the Cloud Services Embedded API. | CloudServicesEmbeddedAPIExample |
| Using the Embedded JavaScript API | Use the Embedded JavaScript API to change client-side behaviour of embedded interviews. | CloudServicesEmbeddedAPIExample |
HotDocs Web Services
The HotDocs Web Service is a RESTful web service, hosted in IIS, which exposes fundamental HotDocs Server features. The walkthroughs below provides instructions on developing against the Web Service REST API.
| Walkthrough | Description | Example Project (GitHub) |
| Upload a Template Package | Upload a HotDocs Template Package File to Web Services using the Web Services REST API. | WebServiceExample1Upload |
| Assemble a Document | Assemble a completed document using the Web Services REST API and the uploaded Template Package File. | WebServiceExample2DocumentAssembly |
| Display an Interview | Display an interview in a web page using the Web Services REST API. | WebServiceExample3InterviewDisplay |
| Read Variable and Dialog Information | Read Variable and Dialog information from the Template Package File uploaded to Web Services, using the Web Services REST API. | WebServiceExample4ComponentInfo |
| Get Interview File | Get individual files from the Template Package File uploaded to Web Services, using the Web Services REST API. | WebServiceExample5InterviewFile |
JavaScript API
The HotDocs JavaScript API allows developers to interact with and customise the HotDocs Interview. By using the API, you can manipulate interview data, link custom function with interview event handlers, add custom buttons, and change the language of the user interface.
| Walkthrough | Description | Example Project (GitHub) |
| Setting and Getting Answers | Set and get values for interview answer fields. | JavaScriptAPIExamples |
| Custom Interview Options | Examples of custom interview options available to use in the interview. These include interview height and width, customs buttons, and disabling interview warning dialogs. | JavaScriptAPIExamples |
| Event Handlers | Register interview Event Handlers and map the events to custom functions. | JavaScriptAPIExamples |
| Get Answer XML from the Interview | Retrieve the current answers in the interview as HotDocs Answer XML. | JavaScriptAPIExamples |
| Using Language Modules | Create and use a HotDocs Browser Language Module. The module changes the interview user interface text to another language. | JavaScriptAPIExamples |
HotDocs Open SDK
The HotDocs Open SDK is a toolkit for developers wanting to integrate HotDocs functionality with their own host applications. Using the Open SDK, developers can integrate with HotDocs Server, HotDocs Cloud Services, and HotDocs Web Services.
| Walkthrough | Product | Description | Example Project (GitHub) |
| Document Assembly | HotDocs Server | Assemble a document using HotDocs Server. | SdkExample1DocumentAssembly |
| Create an Answer Collection | HotDocs Server | Create a collection of answers, used when assembling a document with HotDocs Server. | SdkExample2AnswerCollection |
| Retrieve the Interview HTML Fragment | HotDocs Server | Generate and retrieve an Interview HTML Fragment using HotDocs Server. This is used when displaying an interview. | SdkExample3InterviewFragment |
| Display the Interview and process Answers | HotDocs Server | Use the Interview Fragment to display an interview. This walkthrough also demonstrates how to process data sent back from a completed interview. | SdkExample4InterviewDisplay |
| Using a WorkSession | HotDocs Server | Create and use a Work Session to complete multiple interviews and assemble multiple documents. | SdkExample5Worksession |
| Read Variable and Dialog Information from the Component File | HotDocs Server | Read Variable and Dialog information from a HotDocs Template. | SdkExample6ComponentInfo |
| Using Cloud Services | Cloud Services | Send requests to HotDocs Cloud Services using the Open SDK. | SdkExample7CloudServices |
| Upload a Template Package to the Web Service | Web Services | Upload a HotDocs Template Package File to the HotDocs Web Service. | SdkExample8WebServiceUpload |
| Assemble a Document using the Web Service | Web Services | Assemble a completed document using Web Services and the uploaded Template Package File. | SdkExample9WebServiceDocumentAssembly |
| Display an Interview using the Web Service | Web Services | Display an interview in a web page using the Web Service. | SdkExample10WebServiceInterviewDisplay |
| Get Component File information from the Web Service | Web Services | Read Variable and Dialog information from the Template Package File uploaded to Web Services. | SdkExample11WebServiceComponentInfo |