API Proxy Groups allow multiple API Proxies to be managed as a group.

Policies added to API Proxy Group and applied settings become effective on all API Proxies in the group, thus providing ease of use for API Proxies that need common policies.

An API Proxy can only be in one API Proxy Group. An API Proxy cannot be added to more than one API Proxy Group.

API Proxy Group List

When the API Proxy Group list is first opened, the available API Proxy Groups are listed as in the image below.


Creating a new API Proxy Group

To create a new API Proxy Group, click the (plus) Create button in the upper right corner of the API Proxy Group List interface.

In the form that opens, at least Name information is entered and the Save button is clicked.


After saving, the API Proxy Group configuration interface opens.

Configuring an API Proxy Group 


The configurations in the Overview and Development tabs are exactly the same as that of the API Proxy, with a few minor differences.

Overview Tab

FieldDescription

Name

The name of the API Proxy Group. It is mandatory.

Description

An optional description of the API Proxy Group.

Enable Relative Path

Enables direct access to the API Proxy Group if checked.

Relative Path

The virtual access address to be used to access the API Proxy Group. It is visible and mandatory if the Enable Relative Path option is checked, .

Disable Direct Access to API Proxies


In case the relative path of the API Proxy Group is enabled, direct access to API Proxies may not be desired. In this case, API Proxies added to the API Proxy Group can be closed to direct access with the "Disable Direct Access to API Proxies" option. When this option is enabled, requests to the relative path of any API Proxy in the API Proxy Group will receive the error that the address is inaccessible.
Apply Settings to Related API Proxies

If the Enable Relative Path option is not checked, the policies and API Proxy Group settings (CORS, Cache, Error Response Template, Forwarded IP Header, and Log Settings) in the development tab apply to all API Proxies.

If Enable Relative Path is checked, applying API Proxy Group settings (CORS, Cache, Error Response Pattern, Forwarded IP Header and Log Settings) to the API Proxies becomes optional. For this reason, if it is desired to apply these settings to the API Proxies while this option is checked, the Apply Settings to Related API Proxies option should also be checked.

If Apply Settings to Related API Proxies option is not selected, the settings in the API Proxy Group are only applied when the request comes through the API Proxy Group Gateway Address!

API Proxies in API Proxy Group

API Proxies within the API Proxy Group are managed from this section.

API Proxy Group Key

It is the section where the Public and Private Keys needed for JWT or OAuth2 authorization are managed through the API Proxy Group. See how these keys are managed for an API Proxy for detailed information.

API Proxy Group Settings

For detailed information, see the API Proxy's Overview Tab page, which explains how to make the same settings for API Proxy.


Development Tab

The policies of the API Proxy Group are managed in the Development tab. For detailed information, see the API Proxy's Development Tab page, which explains how to manage policies for API Proxy.


Accessing the Metot/Endpoints of API Proxies in an API Proxy Group

Let the addresses to be used in the examples below be:

If the "Enable Relative Path" option is not checked

Access to API Proxies added to the API Proxy Group remains unchanged. Clients continue to access API Proxies via addresses generated based on the Environments they are installed in.

The URL to send the GET request is

https://demo.apinizer.com/apigateway/petstore/pet/findByStatus?status=pending

If the "Enable Relative Path" option is checked

In this case, the method/endpoints of API Proxies can be accessed via the address of the API Proxy Group.

Accessing a method/endpoint of an API Proxy of type REST

URL is found by adding the address of the method/endpoint to the Relative Path specified for the API Proxy Group. API Proxy's Relative Path is ignored!

The URL to send the GET request is:

https://demo.apinizer.com/apigateway/apiProxyGroup1/pet/findByStatus?status=pending


If a method/endpoint is accessed via the API Proxy Group, the address of the API Proxy is ignored. The method/endpoint is treated as if it directly belongs to the API Proxy Group and the URL of the method/endpoint is created with the address of the API Proxy Group.


If there is more than one method/endpoints with the same address and HTTP method in the REST type API Proxies in the API Proxy Group, the request goes to the method/endpoint found first.


Gruplandırılan API Proxy'lerden herhangi birinde Path Param kullanan bir metot/endpoint nedeniyle grubun içindeki diğer API Proxy'lerde yer alan bazı metot/endpoint'ler erişilemez hale gelebilir. 

Accessing a method/endpoint of API Proxy of SOAP type

It is sufficient to send the SOAP message to the URL of the API Proxy Group with the SOAPAction header.

If "Disable Direct Access to API Proxies" option is not checked

Clients can continue to access the method/endpoints of API Proxies added to the API Proxy Group via the API Proxy address.

The URL to send the GET request is

https://demo.apinizer.com/apigateway/petstore/pet/findByStatus?status=pending

If "Disable Direct Access to API Proxies" option is checked

A request message to API Proxy's address will return an error message stating that direct access to that API Proxy has been disabled.

The URL a GET request is sent to

https://demo.apinizer.com/apigateway/petstore/pet/findByStatus?status=pending 

Response:

{
  "fault" : {
    "correlationId" : "c07b793b-e46a-4177-a11f-4a5d94d667ff",
    "faultCode" : "ERR-134",
    "faultString" : "Direct access to ApiProxy is disabled! Access this endpoint over ProxyGroup URL!",
    "faultStatusCode" : "401",
    "responseFromApi" : ""
  }
}
JS