HTTP Protocol is the most common way to integrate any service provider (including Email service provider). Once the credentials are obtained from service provider, user can navigate to 3rd Party Integration menu on the left and click on New Integration.
Since Email is the service, choose service from Service Type dropdown. Once the option is selected, choose the Send Email service. Here under Type section choose HTTP option as shown in the image.
We provide the comprehensive setting page for 3rd party integration. Here user will provide the credential details received from service provider.
Fields for HTTP protocols
API Endpoint (URL) – This is required field for setting up 3rd party integration with HTTP protocol. Use will pass the URL received from service provider for sending Email
API Method – This is required field as to know the method used by API Endpoint for sending Email
Auth Type – Each service provider has it’s own way to authenticate the request. User need to provide the authentication type. Currently we support 3 auth type: Basic Auth, API Key and OAuth2.
API Key – If Auth Type is selected as API Key user need to provide his API Key detail on the field
Basic Auth – On this type of authentication, user need to provide some more credentials like Username, Password and Endpoint (URL) detail and method for Endpoint to validate.
OAuth2 – Similar to Basic Auth, user need to provide credentials like Client ID and Secret. Except those credentials, user also need to provide Endpoint (URL) detail and method for Endpoint to validate. In this auth type, token field and expiry field are also required to be passed.
ll service provider have their own way of receiving request. Each service provider can have different request structure. User will provide the sample request structure under Data and Header section.
As shown in the image, user can add placeholder in the structure. The placeholders are represented by field between {{ and }}
Some service provider might also require to pass the custom data and header while making auth request. In the scenario, user can provider such detail under Auth Data and Header section similar to Data and Header section mentioned above.
Once all credentials are setup, user can make some tests to make sure all credentials are in-place and correct. Click on Test Settings to test the service provider with credentials.
User can change the data as required for testing and decide if the credentials are correct after clicking on Testing Setting. Once confirmed, he can close the setting panel and click on Save Settings
