Endpoint types supported by Choreo Connect can be categorized based on multiple aspects.
- Based on the key type
- Based on the behavior
- Based on the backend service type
Endpoint Types based on the Key Type¶
- Production Endpoints
- Sandbox Endpoints
When an API is invoked using a JWT (access token or API key), the request gets routed depending on the key type defined in the JWT. In standalone mode, Production and Sandbox endpoints can be defined in the OpenAPI definition using extensions. With API Manager, these can be defined via the Endpoints tab in Publisher. If not defined, the request gets sent to the production endpoint.
Endpoint Types based on the behavior (routing policy)¶
By default, a single endpoint or a collection of endpoints is configured as Load Balanced endpoints in Choreo Connect.
Endpoint Types based on the backend service type¶
The endpoint type and the URL components are processed and validated based on the type of the API during the time of deployment.
|HTTP/ REST Endpoint||A REST service endpoint based on a URI template. The steps to expose a REST service can be found in Deploying a REST API.|
|WebSocket Endpoint||A HTTP based streaming endpoint implemented based on the WebSocket protocol. Once a connection is established with the endpoint, a channel that enables two way communication is created providing pub sub capabilities. The steps to expose a WebSocket endpoint can be found in Deploying a WebSocket API.|
- Passing End User Attributes to the Backend - Backend JWT
- Maintaining Separate Production and Sandbox Gateways
- Backend Certificates
- Mutual TLS Between Choreo Connect and Backend
- Defining a Backend Security Scheme