Getting Started on API Consumption
As a Consumer, the primary goal is to discover, subscribe to, and integrate with the APIs and Products offered by Publishers.
Applications
The Application is the client used to discover, subscribe to, and consume Products. To obtain the necessary credentials for API interaction, the application must first be registered in the Cloud Console.
Products
From a consumer’s perspective, Products are the gateway to the services they need. Consumers can explore Products of varying visibility, reviewing the description and API specifications to decide which ones meet their needs. After subscribing, they can configure their application keys with the right scope to access the desired functionality.
Quick Links for Consumer Workflow
Here are the key steps to consume an API:
- Making your First API call: This guide will walk you through the essential steps to authenticate and successfully make a first API call.
- Accessing Teams: Learn how an user can join an existing team, select their current team, or create a new team.
- Register Your Application: The first step is to register application in the Cloud Console to get client credentials.
- Get Client ID & Secret of the Application: Learn how to get application credentials in the Console.
- Update Your Application Grant Types & Delete Application: Learn how to update Application Grant Types.
- Discover Products: Learn how to find and explore available Products in the Cloud Console.
- Subscribe to a Product: Request a subscription to a Product that fits your needs. This process may involve an approval workflow depending on the Product’s visibility.
- Configure Your Application with Scopes: After a successful subscription, an application’s API keys must be configured to grant access to specific functionality. This access is defined by the Product’s scopes.
- Unsubscribe to a Product: Learn how to unsubscribe a Product & Application.