Skip to main content

Introduction

In this section, you will more details about the Service Catalog.


Overview

The API Catalog is a feature of the StackSpot Platform. As StackSpot's customer, it allows you to make the APIs created available to internal developers and your partners.

You have complete control of the access when you use the API Catalog. You can make your APIs available to others. This ensures a flexible and adaptable experience for users.

See below other API Catalog features:

  • Compatibility with existing standards and technologies (OpenAPI, Swagger).

  • Integration with the StackSpot platform, using Stacks, Plugins, Starters, Actions, Portal, and STK CLI.

  • Your partners can consume the APIs through external access.

The Service Catalog features make it easier to share and integrate APIs. It helps collaboration and accelerates software development.

See the main actions available in the Catalog:

  • Publish and unpublish an API or a set of them.
  • Select API publishing environments.
  • Publish and unpublish a Product.
  • Create an API through the StackSpot Platform.

Concepts

See below some concepts that are part of the API Catalog:

Environments

It is an attribute related to the environments defined in the Product and API entities. An Environment assists in filtering Products and APIs in the Catalog.

Partners

They are StackSpot's customer partner company. They work as a limited StackSpot account. Partners can connect to an existing account on the Platform.

You register a partner manually. After logging in, the Partner can invite other members to access StackSpot.

Members

Members are people who can receive an invitation to access the API Catalog. The person gets the invitation through an e-mail and defines the login password. After that, explore the Products and APIs.

Learn more