Skip to main content
Version: 3.8

Backends

A backend server is the central repository for all API service assets, which are then exposed to the client through a proxy, ensuring secure and controlled access.

backend

Create a Backend Server​

  1. Click Create Backend.

addbckend1

Add Backend Server dialog box appears as shown below.

  1. Enter the Backend Server Name.

  2. Select Backend Server Type as Production or Sandbox from the drop down.

  3. Enter the IP/Hostname and Port.

  1. Select the Gateway you want to map if necessary.
info

If the Backend Server Type is selected as Production, only the production gateway's will be displayed for mapping and if Backend Server Type is selected as Sandbox, only the sandbox gateway's will be displayed for mapping.

  1. Enter the Description.

  2. Select Endpoint Security from the drop down.

The available Endpoint Security Options are listed below.

  • None
  • Basic Authentication
  • WS Security
  • Pass through
info
  • If Endpoint Security is selected as either Basic Authentication or WS Security, the Username and Password fields are displayed.

a. Enter the Username and Password.

info
  • When Endpoint Security is set to None or Passthrough, the Username and Password fields are unavailable.
  1. Select Endpoint Protection from the drop down.

The available Endpoint Protection Options are listed below.

  • None
  • Request Count Limit
  • Traffic Throttle
info

If Endpoint Protection is selected as either Request Count Limit or Traffic Throttle, the Number of requests, Volume, Time Unit and Enforce only during below timings (Start Time and End Time) fields are displayed.

a. Enter the Number of requests.

b. Select the Volume from the drop-down.

c. Select the Time Unit from the drop-down.

d. Enable the Enforce only during below timings checkbox to alter Start Time and End Time values if necessary.

  1. Enable the Proxy Enabled toggle if you want to enable the proxy.
info

  • Only HTTP proxy is supported.

  • THAPIM presently only allows one proxy per environment.

  1. Enable the checkbox to provide backend visibility to the Publisher Group if necessary.

  2. Click Save.

info

Click Cancel to cancel the backend creation process if necessary.

On saving, the confirmation message appears as shown below.

savebackend

Edit a Backend server​

  1. Click the Edit icon.

editbackend

The Edit Backend Server dialog box appears as shown below.

editbckend1new

  1. After making necessary changes, click Update.
info

Click Cancel to cancel the updating process if necessary.

On updating, the confirmation message appears as shown below.

editbackend1

Manage visibility of the Backend​

You can control which Publisher Group(s) have access to the backend.

  1. Click the Edit icon.

backendvisibility

The Edit Backend Server dialog box appears as shown below.

backendvisibility1

  1. Scroll down to the Backend Visibility section.

  2. Enable/Disable the checkbox for the respective publisher group.

  3. Click Update.

On updating, the confirmation message appears as shown below.

backendvisibility2

View APIs on a Backend Server​

  1. Click the Expand Row icon.

viewdepapi1

The row extends and displays the details of the APIs deployed on the Backend server.

viewdepapi1

info

If no APIs are APIs deployed on the Backend server, the message appears as shown below.

viewdepapi2

Delete a Backend Server​

info

  • A Backend Server can be deleted if no APIs are deployed on it.

  • If the backend server is linked to one or more APIs, you must disassociate the APIs from the backend before deleting the backend server.

  1. Click the Delete icon.

deletebackend

A Pop up appears as shown below.

deletebackend1

  1. Click Ok.
info

Click Cancel to cancel the delete process.

On deleting, the confirmation message appears as shown below.

deletebackend1