

Invoke an API using the Integrated API Console

WSO2 API Manager has an integrated API Console, which allows you to visualize the API contract and interact with API's resources without being aware of the backend logic.

Let's see how to use the API Console in the Developer Portal to invoke an API.

Note

You can only try out HTTPS-based APIs via the API Console because the Developer Portal runs on HTTPS.

The examples here use the PizzaShack REST API, which was created in Create a REST API.

1. Sign in to the WSO2 Developer Portal (https://<hostname>:9443/devportal) and click an API (e.g., PizzaShack).

2. Subscribe to the API (e.g., PizzaShack 1.0.0) using an application and an available throttling policy.

   

3. Click Applications and then click on the application that you used to subscribe to the API. Click Production Keys and click Generate keys to generate a production key.

   

   Tip

   Production and Sandbox Tokens

   To generate keys for the Sandbox endpoint, go to the Sandbox Keys tab. For more information, see Maintaining Separate Production and Sandbox Gateways.

   Tip

   JWT tokens

   As the application is self-contained (JWT), copy the generated access token before proceeding to the next step.

4. Click APIs, and click on the API that you need to invoke.

5. Click Test under the resources section of the API.

   

   The OpenAPI UI (API Console) to test the PizzaShack API appears.

6. Enter the copied access token in the Authorization field.

   

7. Expand the GET method and click Try it out. Click Execute.

   

   Troubleshooting

   If you cannot invoke the API's HTTPS endpoint (this causes the SSLPeerUnverified exception), it could be because the security certificate issued by the server is not trusted by your browser. To resolve this issue, access the HTTPS endpoint directly from your browser and accept the security certificate.

   If WSO2 API Manager has a certificate signed by a Certificate Authority (CA), the HTTPS endpoints should work out-of-the-box.

Note the successful response for the API invocation.

You have now successfully invoked an API using the Open API Console

Invoke an API deployed on a cloud cluster

Before You Begin

You need to have an API published to a cloud cluster in order to invoke the API as follows. For instructions on how to publish an API to a cloud cluster in PrivateJet Mode, see Publish an API to a Cloud Cluster in PrivateJet Mode.

1. Sign in to the WSO2 Developer Portal (https://<hostname>:9443/devportal) and click on the API that you deployed on a cloud cluster.

   Note

   You can find the accessURL that corresponds the API under Gateway Environments.

   

2. Subscribe to the API using an application and an available throttling policy.

   

3. Click Applications, click on the application that you used to subscribe to the API. Click the Production Keys tab and click Generate keys to generate a production key.

   

   Tip

   Production and Sandbox Tokens

   To generate keys for the Sandbox endpoint, go to the Sandbox Keys tab. For more information, see Maintaining Separate Production and Sandbox Gateways.

   Tip

   JWT tokens

   As the application is self-contained (JWT), copy the generated access token before proceeding to the next step.

4. Click Try Out to navigate to the API Console.

5. Select the Gateway as configured container management cluster.

   

6. Expand a method and click Try it out. Click Execute.

   

Get a test key to invoke an API

When you want to test out the process of invoking an API resource, you can easily get a test key from the API console rather than going back to the Applications page and generating a key. Click Try Out to navigate to the API Console, click on the GET TEST KEY button to generate a test key.

Tip

TEST KEY will be generated with default scopes attached to the API. If you need to generate a token with specific scopes, go to the application view and generate a token.

Top