Working with Endpoints
An endpoint is a specific destination for a message such as an address, WSDL, a failover group, a load-balance group etc. WSO2 API Manager supports a range of different endpoint types, allowing the API Gateway to connect with advanced types of backends.
Endpoint Type | Description |
|---|---|
HTTP endpoint | A REST service endpoint based on a URI template. |
Address endpoint | The direct URL of the service. |
Failover Group endpoint | The endpoints that the service tries to connect to in case of a failure. This happens in a round robin manner. |
Load Balance endpoint | The endpoints to which incoming requests are directed to in a round robin manner. They automatically handle fail-over as well. |
Default endpoint | The default endpoint sends the message to the address specified in the To header. |
Note the following:
You can expose both REST and SOAP services to consumers through APIs.
You cannot call backend services secured with OAuth through APIs created in the API Publisher. At the moment, you can call only services secured with username/password.
The system reads gateway endpoints from the
<APIM_HOME>/repository/conf/api-manager.xmlfile. When there are multiple gateway environments defined, it picks the gateway endpoint of the production environment. You can define both HTTP and HTTPS gateway endpoints as follows:<GatewayEndpoint>http://${carbon.local.ip}:${http.nio.port},https://${carbon.local.ip}:${https.nio.port}</GatewayEndpoint>If both types of endpoints are defined, the HTTPS endpoint will be picked as the server endpoint.
Advanced Endpoint Configuration
WSO2 API Manager provides controlling the production and sandbox endpoints with Advanced Endpoint Configuration.
To configure your endpoints with this feature, go to the edit view of the API, navigate to the Implement tab and click the cogwheel icon next to the endpoint you want to configure.
The Advanced Endpoint Configuration dialog box appears as below.
When creating (or updating) Failover endpoints through the Publisher UI (in the Implement tab), you need to go into the Advanced Options of each endpoint and specify the values for the Endpoint Suspension State by setting transport error codes for the endpoint to fail over on and take off the Initial Duration by setting its value to -1.
For more information about endpoints and how to add, edit or delete them, see the WSO2 ESB documentation.