• Docs
  • Consume
  • Test APIs

Test an API

Before using your API in production, you can test it using the integrated console in Choreo. Once you deploy your API in the required environment, an API consumer can use the application credentials, generate an OAuth 2.0 token, and invoke the API to test its functionality by providing values for the required parameters.

This guide will take you through the steps to test an API in Choreo.

  1. Sign in to Choreo Developer Portal at https://devportal.choreo.dev. Alternatively, click Developer Portal on the Choreo Console header.

    Developer Portal

  2. Click APIs.

  3. Select an API you want to test and click Try Out on the card. In this case, skip step 4. Alternatively, you can click on the API and follow step 4.

  4. In the left pane, click Try Out.
  5. Select the required environment from the Environment list.

    Test Panel

  6. From the Subscribed Application list, select the application you used to subsribe the API to. To learn how to subscribe to an application, see Manage Subscriptions.

  7. Click Get Test Key on the Access Token field to generate a test access token. To learn more about access tokens and generating tokens for production usage, see Manage Applications.

  8. Next, expand a resource you want to test by clicking on it.

    Test Resource

  9. Click Try it Out to enable the resource to be tested.

  10. Fill in values for the required parameters and click Execute.

    Test Resource

  11. Once Choreo executes the request, you can view the response in the Choreo Console.