Working with Catalogs

Products must be staged and published to a Catalog to be accessible to application developers through their consumer organizations.

When you create a provider organization, API Connect creates a sandbox catalog by default. The characteristics of the sandbox catalog are:
  • The sandbox catalog is designed for API development and testing.
  • The sandbox catalog cannot be deleted and does not have production mode or Spaces options under catalog settings.
  • A sandbox catalog includes a default application and a consumer organization.

In API Connect, you can create multiple Catalogs. Catalogs are useful for separating products and APIs for testing before you make them available to consumer organizations. The syndication feature in API Connect means that you can also publish a product to a Space in a Catalog.

Note: In the The Help icon.Help page of the API Manager, and IBM API Studio user interfaces, click the Product information tile to find out information about your product and Git package versions. The IBM API Studio product information is based on its associated management server, but the Git information is based on where it was downloaded from.

A Catalog is a staging target, and behaves as a logical partition of the gateway and the . The URL for API calls and the are specific to a particular Catalog. In a typical configuration, an API provider organization uses a development Catalog for testing APIs under development and a production Catalog for hosting APIs that are ready for full use. A common approach is to have a development cloud with a development Catalog, a few test Catalogs and a production cloud that might have its own test Catalog.

You can use a Space to partition a Catalog so multiple teams can manage products and APIs independently in a single Catalog. A Space is conceptually like a sub-catalog, except that products and APIs in all Spaces in a given Catalog are published to the same . For more information about Spaces, see Using syndication in API Connect.