Adding a WebSocket type non-Infor endpoint

Use these steps to add a WebSocket type non-Infor endpoint in API Gateway. You can add the endpoint to an existing API suite or create one specifically for non-Infor endpoints.

  1. Navigate to the API suite.
    Access the API Gateway interface and locate the API suite where you want to add the WebSocket endpoint. This can be an existing suite or a newly created one for non-Infor endpoints.
  2. Add a new endpoint.
    Within the API suite, click the + button on the Endpoints tab.
  3. Enter the WebSocket target endpoint URL.
    Provide the WebSocket server URL, starting with ws:// for non-secure connections or wss:// for secure connections. Enter this URL in the Target Endpoint URL field.
  4. Verify the proxy URL.
    After submitting the deployment configuration, check the proxy URL on the Endpoint Detail page to confirm that the endpoint has been set up successfully.
The WebSocket type non-Infor endpoint is added in API Gateway and is ready for testing and monitoring.

Testing the endpoints

After configuring the WebSocket endpoint, test its functionality to ensure that it operates correctly. You can use web clients or API testing tools such as Postman to perform these tests.

To test using a web client:

  1. Open a web client that supports WebSocket connections, such as Chrome Developer Tools.
  2. Navigate to the console and enter the WebSocket server URL, for example ws://example.com/socket or wss://secure.example.com/socket.
  3. Initiate the connection and send test messages to verify communication.
  4. Observe the responses and check for errors or unexpected behaviour.

To test using an API testing tool:

  1. Open Postman or another API testing tool that supports WebSocket connections.
  2. Select the WebSocket request type and enter the WebSocket server URL.
  3. Connect to the server and send test messages to verify functionality.
  4. Review the responses for success indicators or error messages.

These tests help confirm that the WebSocket endpoint is operational and ready for monitoring and further use.