Exchange API icon

Exchange API

(3 reviews)

API Notebooks

You can use a notebook to test all the Exchange API v2 endpoints. Use a client to make requests and see example responses. Explore the API and learn how it works and how to use it.

This client is an example provided by Exchange that does not require credentials. If you choose to use your credentials, use client authentication.

1. Create a Client for Exchange API v2

Create a notebook client where you can execute sample code to test and explore the API:

2. Optionally Authenticate the Client

Note: This step is optional. Some endpoints do not require authentication.

The Exchange API v2 uses OAuth 2.0 to enable secure access to the resource.

Obtain an access token:

3. Invoke the API

This scenario shows the most basic flow, which obtains an asset response from the API.

Then the name of the asset is obtained from the response.

Then another code snippet obtains the labels of the asset.

Use your OAuth token to invoke the API.

4. Continue using the API

To continue using the API, create new API Notebooks like this, where new methods can be created or executed.

For example, this notebook makes a request to search assets by the search term Exchange and the type rest-api in the domain of anypoint-platform: