Reference Topic

Advance API Overview

The HotDocs Advance API provides you with an interface to integrate Advance functionality into your own applications. For example, you can use the Advance API to embed HotDocs interviews in your own application.

The following documentation provides a guide to the key concepts and tasks you need when using the API.

Overview

The HotDocs Advance API gives you access to Advance functionality, enabling you to integrate HotDocs features with your own applications.

Using the API, you can create, edit, and delete Advance resources (e.g. work items, users, work groups), as well as retrieving data about the resources that exist in Advance. Typical use-cases for the API include:

• Embedding a HotDocs interview in your own application
• Creating new work items, using data from your own application to pre-populate the HotDocs interview
• Retrieving details of all new work items created during a particular time-frame

HotDocs Advance Web API is based on REST, with resource endpoints. The API uses standard HTTP verbs and response codes and returns JSON responses.

Authentication is required through authorization flows and the creation of clients with credentials.

Workflow

Manage API Clients

Authenticate

Use the API

Getting started

• Getting Started – steps for making your first request to the Advance API
• Advance Concepts for API Users – an overview of concepts you need to know when using the API
• See Advance REST API Base URL to find the URL to which you will make API requests.

API Documentation

Concept Topics

• Advance REST API URL
• Authentication flows
• API clients
• Scopes
• Assembly Sessions

How To Topics

Managing API Clients

• Log into the API Client Management application
• Create a new API client
• View a client's details
• Edit an API client
• Activating and deactivating a client
• Add a service principal to a client
• Remove a service principal from a client
• Activating and deactivating a service principal

Authenticate with the API

• Get an access token using the Resource Owner authorization flow
• Get an access token using the Implicit authorization flow

Using the API

• Create a user
• Create a work item
• Template management through the API
• Assembling Documents Overview

Using Webhooks

• Webhooks Overview

Working with HotDocs Answer Sets

• HotDocs Answer Sets Overview
• Validate a HotDocs answer set

Code Examples (C#)

• Code examples overview
• Resource Owner flow authorization example
• Implicit flow authorization example
• Create user example
• Create work item example
• Display Interview Example