Using the API Overview

This document provides an overview of how-to guides for using the HotDocs Advance API.

Prerequisites

You must have an API client to use the HotDocs Advance API.

API Documentation

You can view the latest reference documentation for the Advance API at https://yourorganization.com/HdaApi/rest/documentation/index.html, where yourorganization.com is the domain under which your Advance deployment is located.

You can view the latest documentation for the Advance API at http://hotdocsadvance.com/api/rest/documentation/index.html

API Base URL

See Advance REST API Base URL to find the URL to which you will make API requests.

Workflow

When using the Advance API, you must create a client if you do not already have one. To make a request, you must first get an access token from Advance. Depending on the authentication flows your client uses, you can get an access token in the following ways:

Getting an Access Token using the Resource Owner flow – for clients that use the Resource Owner flow
Getting an Access Token using the Implicit flow – for clients that use the Implicit flow

The access token is then sent in the authorization header of a request to the API.

Once you have retrieved the token, you can make requests to the Advance API. See the link in the API Documentation section above to access the API documentation.

API Topics

Authorization

User Management

Creating a User

Work Items

Template Management

Assembling Documents

Public Interview Links

Code Examples

There is a selection of examples in our Code Examples documentation. The examples cover the following tasks: