Skip to content

Consuming an API ​

This guide is for consuming roles connecting to an API another team has published. For the full first-time walkthrough, including creating the application and making the first call, see Consume your first API.

1

Open the API catalog

Open APIs from the main navigation.

2

Find the API

Browse the cards, use Search by name, or filter by consumption (Both, Already consumed, Not consumed) and Apply filters. Each card shows the version, description, quota, methods, security schemes and latest update.

3

Open the API

Select Documentation on the card to open the API's page with its versions and interactive specification.

4

Review the specification

Check the operations, parameters and schemas you need. Open the page menu beside the title for Download spec, or Compare versions to see what changed between two versions.

5

Subscribe an application

Select Request access on the API's card, tick one or more of your applications and Save. Or open the application under My Applications and use Add/Remove APIs. See Managing your applications.

INFO

Producers assign specifications to a backend team from the same page menu. See Exposing your API, and Reference: API catalog for every control on an API's page.