Contact Us 1-800-596-4880
  1. Homepage
  2. API Experience Hub
  3. Discovering and Consuming APIs

  4. Using the API Console

Using the API Console

The API Console is an interactive component that shows information about REST APIs and their methods, and enables you to test the methods by sending requests. The API Console is located in the API Details page. Endpoints are displayed in alphabetical order.

The API Console displays the API specifications and documentation information that are critical to the onboarding process and adoption. Developers want to know how to use and integrate APIs.

The Specification pane displays the navigation of the HTTP functions in the REST specification for a REST API. You can understand the format and structure of an output by reviewing the resources and methods.

The Documentation pane displays interactive documentation about an API. API documentation includes detailed descriptions of each API version. This documentation is updated with the API release cycle, usually with close involvement from the development team. You can also review the request information and responses.

The Try it pane enables you to test REST APIs using the mocking service or an API instance URL. The mocking service lets you test endpoints defined in the API specification without an actual server to handle the requests and responses. The mocking service enables you to add simulated data to an API function and test the API with that data. All the responses are example data. Using an API instance enables you to interact with a server and get real data for real requests and responses.

Review API Specifications and Documentation

To discover information about an API:

  1. On the Home or the APIs page, select an API.

  2. Select the API specification tab.

  3. In the Specification pane, click a function.

  4. In the Documentation pane, review the summary of the function.

  5. Select the Requests tab to view the information for the code example, parameters, security, headers, examples, and body.

  6. Select the Responses tab to view the response type, example, headers, and body.

Test APIs

You can test an API specification using the mocking service when you want simulated data. You can also test an API specification with real data using an instance of the API. If an instance has authorization headers, the request fails when the authorization headers aren’t entered.

For more information about testing APIs, see the following topics: