The HotDocs Application Programming Interface (API) lets you integrate HotDocs document assembly software functionality into your own application. For example, by integrating your application with HotDocs, you could allow your users to assemble HotDocs text and form documents using your application’s data. Although HotDocs can be integrated with virtually any kind of software, it is most often used with database applications, case managers, litigation support systems, infobases, address books, and other similar applications.
There are three types of people involved in the integration process:
Integrator: The most basic role of the integrator is to make data from your application available to HotDocs using the API. In addition, the integrator may also provide a way for HotDocs to be launched (visible or hidden) from within your application to assemble documents.
Template Developer: The template developer's role is to create one or more HotDocs templates, which might use information from your application. If information will be pulled from your application, the template developer can use the HotDocs Variable Mapping dialog box to map fields in your application to HotDocs variables in each template.
End User: The role of the end user is to assemble a text or form document using information from your application or answers entered during an interview. Depending on the type of integration you create, the user may or may not need to be actively involved.
This help file focuses primarily on the role of the integrator, or software developer. The roles of template developers and end users are discussed only to show how the integrator's work helps them perform their tasks.
If you are unfamiliar with HotDocs and its terminology, please refer to the Glossary to see a list of concepts and terms associated with HotDocs.
The HotDocs API provides methods for creating several types of integrations. Using the COM API, your application can act as the main user interface for your users. For example, it can launch HotDocs, tell it which template to use, and provide it with data it needs to assemble a document.
Another type of integration you can create is an answer source integration, which is a special DLL file that HotDocs can use to query your application for the data it needs to assemble a document. When using an answer source integration, the user is more involved in selecting the template and determining what information from your application should be used.
HotDocs also provides a plug-in API, which lets you to create a plug-in that adds a new menu to the HotDocs library window, overlays custom icons on top of template icons in the library, or otherwise extends the menus and functionality of the HotDocs library window.
Finally, the Variable Mapping API allows you to create associations between data fields in your application and HotDocs variables.