There are two types of APIs that can be added to a workspace:

  1. Linked - These APIs are hosted on 3rd party services and linked within the DfE Find and Use API Catalogue.
  2. Hosted - These APIs are directly hosted on the DfE service.

Both Linked and Hosted APIs have similar left menu tab options:

  • Overview
  • Metadata
  • Documents
  • Environments
  • Operators

However, you will notice these additional left side menu tabs when managing **Hosted APIs:

  • Authentication
  • Policies
  • Subcriptions

The steps for adding and managing Linked APIs within your workspace differs from that for Hosted APIs. This includes the fields neccessary to validate and publish them into the DfE Find and Use an API Catalogue.

Managing Hosted APIs

To add and manage a Hosted API in your workspace, simply follow the steps detailed in Managing Hosted APIs

Managing Linked APIs

To add and manage a Linked API in your workspace, simply follow the steps detailed in Managing Linked APIs