How To Define a Mail Policy?

What is Mail Policy?

ApiGo enables the users to receive an email when an API is called using the Simple Mail Transfer Protocol (SMTP). The Mail Policy allows ApiGo users to instruct the gateway to deliver a pre-configured email message whenever their developers call for an endpoint.

The policy helps the tenant admins to control the endpoints via email. In ApiGo Management Portal, tenant admin can define mail policies and forward them to various receivers. The admin can define mail policies for specific email addresses with specialized messages.

How It Works?

  1. Tenant admin may use the below path to complete the necessary settings if the configurations has not been adjusted before. Management Portal provides an easy and quick solution to inform ApiGo users about any responded API call.

Management Portal -> Configurations -> SMTP Settings

  1. ApiGo users can be notified with an e-mail when the gateway responds to a TPP request. A mail policy can be defined for any API in the endpoint definition screen.

Management Portal -> Endpoints -> Add Endpoint -> Add Policy -> Mail Policy

_images/MailPolicyPicture1.PNG
  1. Tenant admin can add a new e-mail address to inform about the responded API call. The informative message can send to more than one receiver. With an add email button, tenant admin may add new email addresses. Also, the message subject and body can be configured on the policy wrapper.
_images/MailPolicyPicture2.PNG
  1. TPP sends a request to the gateway, and the API call is responded to successfully. In the meantime, an e-mail is sent to the defined email addresses with the message subject and body, which is entered via Management Portal’s Policy Screen.
_images/MailPolicyPicture3.PNG
  1. The informative mail is sent to the relevant email addresses and the SMTP settings need to be already configured to complete the process successfully.
_images/MailPolicyPicture4.PNG