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}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

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

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

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

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 under. 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 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 is a very flexible scheme that gives you fine grain control over API’s that can be accessed using any given API key.

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 that have been created under the context of that account.

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