Overview

The API Hub provides access to Thredd's API suite using a single URL. You can access services across all environments using this single URL, which will then send you automatically to the correct service and environment. Using a single URL provides you with a single, consistent interface for accessing the Thredd platform, simplifying integration and enabling seamless scalability.

The below diagram shows some of the different services that API Hub connects to:

  • Card management enables you to create and manage cards
  • Event delivery service enables you to use Thredd's webhooks, enabling you to send notifications to your customers
  • Digital wallets enables you to set up Google and Apple In-App Push Provisioning
Figure 1: API Hub Overview

Figure 1: API Hub Overview

Authentication

Authentication to the API Hub is done using Thredd's trust framework. The trust framework is comprised of two parts:

  • Cloudentity, which handles who can access what and enforces authorisation policies
  • Raidiam Connect, which establishes trusted entities, issues and validates certificates, and registers clients

For more information on the trust framework, see the Connecting to Thredd Guide.

Best Practice

  • When implementing an API call, you must at a minimum include the mandatory request fields and handle the fields that are mandatory in the response.
  • Where a field requires you to submit a code value or returns a code value, our documentation provides links to the relevant appendix for details. If in doubt as to which code to include in your request, use the default or recommended value.
  • Don't use spaces in field names.

What’s Next

See Accessing API Hub for information on how to access the Thredd API Hub platform