Deploy WebSocket API in Choreo Connect

A Web Socket API can be deployed in Choreo Connect via API Manager.

Info

Before you begin

This guide assumes that you already have a Choreo Connect instance that is up and running. If not, checkout the Quick Start Guide on how to install and run Choreo Connect. To learn more about Choreo Connect, have a look at the Overview of Choreo Connect.

Step 1 - Create a WebSocket API in API Manager

For instructions on how to create a WebSocket API, see Create a WebSocket API.

Step 2 - Deploy the API in the Choreo Connect environment

For more information on deploying the API in Choreo Connect, see Deploy API.

Step 3 - Generate an Access Token to invoke the API

By default, the WebSocket API is protected by an OAuth2 token.

For more information on generating a JWT Access token, see Get a Test Key to Invoke an API.

Invoke the API using a WebSocket client

The WebSocket API exposed via Choreo Connect can be invoked by using a WebSocket client. The JWT token should be set as the Authorization header in the initial WebSocket handshake request.

Note

The same ports 9095 (HTTPS) and 9090 (HTTP) are used for WebSocket APIs.

Invoke the WebSocket API by carrying out Step 4 in the Create and Publish a WebSocket API tutorial.

Top