Publish API products and keep their history.

Your team adds API products in the admin portal. Partners browse them and read the docs in their own portal.

Start with a spec.

Create the API product and import its endpoints from an OpenAPI file. Once published, partners can find it in the catalog.

Fig 7.1

Sample API product

Illustrative
API product
Orders
Spec
OpenAPI, imported
Latest version
v2
Release type
Breaking
Release notes
Order IDs are now strings.
Sunset date for v1
30 June

Changes go through review.

After publishing, edits and price changes need a change request. The account that raised it can't approve it.

Fig 7.2

Each version has a record.

The history holds the release type, release notes and release candidates. A breaking release needs a sunset date for the version it replaces, so partners know what's coming.

You decide who gets access.

A partner asks for access to an API product. An admin approves or rejects the request, and can suspend or reinstate that access later.

See it with your team.

Bring the people who'd run it. We reply within 24 hours.

Request a walkthrough