Documentation

This is taking longer than usual. If nothing appears, refresh the page.

Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

API keys

An API key is typically used in conjunction with one of Hornbill’s pre-built or customer-built integrations and import tools to enable machine-to-machine authentication, where initial integration during setup is required, as well as to remove the need to specify plain-text credentials in configuration files that will be located on computers at the point of integration.

Creating an API Key

Click on the + button to start creating a new API key.

  • User Account
    The user account under which this API will run. The API will inherit the rights of the selected user. The API Key can be restricted further by using rules.
  • Description
    This is a simple description of the API key that is being created
  • State
    This defines the current state of the API key. The options are Active, Revoked or Suspended. Any API key that is not in an active state cannot be used.
  • Expires
    This defines the date and time until the API key is active. Once the expiry date is reached, the API key can no longer be used. This is mandatory, following best security practices.

API Key Expiry and Auto-Delete

Once an API key has expired, it will automatically be deleted from the system 7 days after the expiry date is reached.

API Key Rules

API Key rules are a very flexible scheme that gives you granular control over APIs that can be accessed using any given API key.

API Key Rules

Multiple rules can be added, with each rule being placed on a new line.

Learn more about API Key Rules

Tip

API Keys can also be viewed or managed from a user account. Each user account will show any API Key that has been created under the context of that account.

  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document