Test an API from the browser

Learn how to explore the API documentation and test an API from the browser using the built-in test capability.

3 minute read

Unified Catalog has an built-in testing tool that allows you to explore the list of API endpoints and their related documentation, and test the API methods directly in the browser. It is built over the official Swagger.io and supports both OAS2 and OAS3 specifications.

Authenticate an API with an API key

Before you start:

  • You will need to create an application with an API key
  • You will need to subscribe to an API with your application. See Subscribe to an API.

To test an API that has been registered in AMPLIFY Central and secured with an API key:

  1. Select Catalog in the left navigation bar to open the Explore Catalog submenu.
  2. Click an API asset in the list to see its details.
  3. Click the Test Methods tab.
  4. Choose your Application from the list of existing apps. If you only have one, it is automatically selected for you.
  5. Select your API Key from the list of existing API keys. If you do not have an API key, click the + icon next to the API Key list to create one.
  6. Execute an API method. It should be successful and return a 200 OK response.

Watch the animation to learn how to authenticate with an API key.

Authenticate with API key

Authenticate an API with OAuth

Before you start:

  • You will need to create an application within your third-party OAuth server.
  • You must create an OAuth profile in your app.
  • You will need to subscribe to the API with your created app. See Subscribe to an API.

To test an API that has been registered in AMPLIFY Central and secured with OAuth:

  1. Select Catalog in the left navigation bar to open the Explore Catalog submenu.

  2. Click an API asset in the list to see its details.

  3. Click the Test Methods tab.

  4. If you have more than one valid OAuth profile, choose the one to test. If you only have one, it is automatically selected for you.

    When you select a valid OAuth profile, your Client ID is displayed in a read-only field. This will assist you in generating an OAuth token from the correct application in your third-party OAuth server.

  5. After your third-party OAuth server has generated a valid OAuth token, paste that token into the OAuth token field. You can now attempt to make valid API calls with your API.

Watch the animation to learn how to authenticate with an OAuth token.

Authenticate with OAuth

Authenticate an API with a JWT token

Before you start:

To test your API that has been registered in AMPLIFY Central and secured with a JWT token:

  1. Select Catalog in the left navigation bar to open the Explore Catalog submenu.
  2. Click an API asset in the list to see its details.
  3. Click the Test Methods tab.
  4. Use the Application ID and JWT Key ID to create the JWT token.
  5. Paste your JWT token in the JWT Token field.
  6. Execute an API method. It should be successful and return a 200 OK response.

Watch the animation to learn how to authenticate with a JWT token.

Authenticate with JWT

Further information