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

Open API

Hornbill’s APIs are a JSON/XML based API. It’s a web services API, meaning it’s called by sending and receiving XML or JSON messages over HTTPS following the HTTP protocol and XML/JSON data representation standards. Hornbill API’s make use of the XML Schema Specification to describe all input and output message formats as well as data constraints and complex data structures expected.

The key characteristics of Hornbill’s API are:

  • Fully documented: The platform, as well as each application that publishes specific API’s will also include dedicated API documentation (see below)
  • Web API: Modern, human readable inputs and output messages makes use by developers simple.
  • Simple To Understand: Standard request/response remote procedure call pattern
  • High Compatibility: Works easily with JSON and web browsers, or back end systems that support JSON or XML
  • Secure: Can use API keys or session-based authentication.

API Documentation

The following API reference guides are available for customer and third-party integration developers: -

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