Consuming an API
This guide is for consuming roles — anyone connecting to an API that another team has already published, rather than publishing one yourself. If you're the one exposing an API for others to consume, see Exposing your API instead.
Open the API catalog
In the left sidebar, under Developer Portal, select APIs.
Find the product
Browse the list or use filters your organization provided (for example by category or status).
Open the product page
Select the API name or row you are interested in to see its description, versions, and technical documentation.
Review the specification
Open the interactive specification to check the operations, parameters, and schemas you'll need. If the portal offers more than one language, switch it in the top bar to see a translated view when the producer published a locale overlay. A warning on the spec means apply fell back and you are reading the canonical document.
Add it to an application
Use the action that adds this product to one of My Applications so you can obtain credentials and call the API. See Managing Your Applications.
INFO
Producing teams and the CI/CD role publish and reassign specifications from this same page — see Exposing your API for that flow, and Reference — API catalog for every control a product page offers (version selector, changelog, code snippets, and ownership).
Related topics
- Managing Your Applications
- Managing Your Teams
- Exposing your API — the producer-side flow
- Translated specifications