Gateway Support for WebSocket

This chapter describes how to set up, test, and monitor WebSocket endpoints in API Gateway.

Setting up Infor non-provisioned endpoints

Note: The Infor application team must have registered at least one endpoint on their application suite as WebSocket type in the registry.
  1. Go to the Infor non-provisioned API suite.
  2. Click Add Deployment, select WS as the protocol, and click Submit.
  3. Enter the WebSocket server URL in Target Endpoint URL, The WebSocket URL begins with ws:// or wss://.

The Infor non-provisioned endpoint is set up in API Gateway. You can verify the proxy URL on the Endpoint Detail page.

Non-Infor endpoints

You can add a WebSocket endpoint to an existing suite or a new non-Infor suite.

To add a WebSocket endpoint in ION API Gateway, add the prefix ws:// or wss:// to your Target Endpoint URL when you create the new endpoint.

Testing the endpoints

The endpoint can be tested from web clients or API testing tools such as Postman. Follow the instructions in the corresponding client’s guide on how to enable WebSocket testing on those clients.