Web Services API

This help file contains information you need to use the HotDocs Web Services API with your HotDocs Server host application. HotDocs Server is the server-based version of HotDocs that allows HotDocs interviews (data-gathering sessions) to be displayed by a standard Web browser and documents to be generated (assembled) on the web server, without requiring any special software to be installed on an end-user's computer. The HotDocs Web Services API is designed to mimic the HotDocs Cloud Services API to allow you to more easily switch between the two, however Web Services API does not use SOAP API or support embedded interviews.

The Web Services API installs separately from HotDocs Server itself. It is a RESTful web service, hosted in IIS, which exposes fundamental HotDocs Server features to callers. If you need a host application to run on a different machine (or a different platform) than HotDocs Server you can choose to install and use the web services API, and then design your host application to access HotDocs via this REST interface. This help file contains the methods which you need to be familiar with to use this web service.

Before you can use the Web Services API you need in run the installer you received from your HotDocs representative.

This API is supported only for HotDocs Server 11 installations.