This documentation is for WSO2 API Manager 1.10.0 View documentation for the latest release.
Page Comparison - Working with Endpoints (v.5 vs v.6) - API Manager 1.10.0 - WSO2 Documentation

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 TypeDescription
HTTP endpointA REST service endpoint based on a URI template.
Address endpointThe direct URL of the service.
Failover Group endpointThe endpoints that the service tries to connect to in case of a failure. This happens in a round robin manner.
Load Balance endpointThe endpoints to which incoming requests are directed to in a round robin manner. They automatically handle fail-over as well.
Default endpointThe 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.xml file. 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:

    Code Block
    languagexml
    <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.

    Tip

    Tip: When you define secure (HTTPS) endpoints, set the <parameter name="HostnameVerifier"> element to AllowAll in the <APIM_HOME>/repository/conf/axis2/axis2.xml file's HTTPS transport sender configuration:

      <parameter name="HostnameVerifier">AllowAll</parameter>

    If not, the server throws an exception.

    Anchor
    advanced
    advanced

  • 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 a set of 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.