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

INDEX

Documentation Library

Search for information on Hornbill Documentation.

{{docApp.searchError}}

{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}

Have questions about this site?

What is this site?

  • This website is Hornbill's new product documentation website and is currently under development.
  • It is intended that all existing and future public-facing documentation we produce will be available to search, browse and share.
  • Hornbill's current documentation is available at Hornbill Wiki but over time this content will be migrated to this documentation site.
  • Please feel free to have a look around at any time.

Why has Hornbill created this site?

  • Hornbill's products have moved on considerably since we introduced it almost 10 years ago. At the time, the MediaWiki tool was sufficient, but we have outgrown it.
  • Our customers are more enterprise focused and more self-sufficient than ever before, so for 2023 and beyond we have established a new documentation platform and team to drive our documentation initiative forwards.
  • We are aiming to deprecate the use of Hornbill Wiki for most Hornbill related documentation.
  • We want to enable our growing partner network with product resources and information, documentation beyond our Wiki approach is required.
  • We could definitely do with some help, and may even pay for some! If you have domain knowledge and would like to help, please check out our Hornbill Docs Contributor Guide and contact the Hornbill docs team at docs@hornbill.com.

What will this site be good for?

  • Community contribution will be facilitated, encouraged, and most welcome.
  • High quality documentation, will be kept up to date as rapidly as our products evolve.
  • Real-time content search and discovery.
  • Articles organized into books, books into libraries, creating a more natural and logical structure to our documentation.
  • Legacy API documentation and various other documentation sources will all be consolidated into a single unified documentation system.
  • Documentation available in browser as well as printable/viewable as PDF on demand.
  • Personalized documentation experience, allowing dark/light mode, article subscriptions, social media sharing and other useful features.
  • Almost all publicly available documentation on docs.hornbill.com will be open-source and available to fork on GitHub, allowing customers to derive their own custom documentation around Hornbill products should they wish to.

What is the timeline for this site?

  • We have taken the decision to publish and make available early, there is very little content at this time.
  • As and when we have completed/usable documentation, it will be published here.
  • We have a host of additional features we wish to add over time, so please watch this space.
  • We expect most of our existing documentation should be reviewed/migrated to docs.hornbill.com over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{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...

Postman Examples

  • Article
  • 2 minutes to read

About Postman

Postman is an API testing platform that developers use to design, build and test APIs from a cross-platform desktop client or on the web.

See the Postman website for more information, or to subscribe and/or download the Postman client.

Audience

The primary audience for the Hornbill Platform Postman Collection is developers with an interest in building integrations from external sources into the Hornbill Platform.

It can be considered an aid to learning, and an extension to the Platform API documentation found elsewhere in this book, to help developers understand and visualize what is required when making API calls into the Hornbill Platform.

Example

In the image below we have used the admin:userCreate API example from the Hornbill Platform Postman Collection to create a new user on a Hornbill instance:

Postman Example

Download

The required files are contained in a ZIP archive, which can be downloaded here.

Once downloaded, extract the archive, which contains two files:

  • hornbill.postman_environment.json - This is a Postman environment file, which contains the necessary environment variables
  • hornbill_platform.postman_collection.json - This is a Postman collection file, which contains the example API definitions

Installation

  • In Postman, click on the Environments tab in the left-hand menu
  • Click the Import button, find the hornbill.postman_environment.json file that you extracted from the ZIP archive, and import
  • Click on the Collections tab in the left-hand menu
  • Click the Import button, find the hornbill_platform.postman_collection.json file that you extracted from the ZIP archive, and import

Configuration

To authenticate your API calls using an API Key generated against a Hornbill user:

  • Open the imported Environment in Postman, and update the current values for the APIKEY and ENDPOINT variables within the imported environment:
    • The APIKEY variable should be populated with a time-limited API Key, generated against an account in your Hornbill instance. For further information, please see our API Key documentation
    • The ENDPOINT variable should be populated with the API endpoint for your Hornbill instance. To locate and copy this:
      • Log in to your Hornbill instance
      • Click on the configuration cog
      • In the configuration search, type in usage, and select the Subscription / Usage result in the Platform section
      • Click the Support tab, and copy the Endpoint value from the resulting page
  • Set the Environment as Active

Once the above steps have been completed, you will then be able to make API calls into Hornbill from the imported collection.

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