The guide will illustrate how to create an HTTP Client, that abstracts the majority of boilerplate configurations.
Alumio dashboard provides access to create HTTP client entity that primarily defines the request header structure, handle authentication, and configure SSL parameters.
The below depicts an example of how the header of the API call can be modified as per requirements. To create an HTTP client navigate to Clients -> HTTP Clients and click the + symbol at the top right corner.
An example HTTP Client is as shown below,
Add Plugins to use
Provides an extensive list of the header, URL, cookies, cache, storage manipulations, log control, and so on.
The Add base URI to requests is a handy feature that exempts the end-user from adding the base URI repeatedly with every API call, Alumio will automatically append the base URI if Http Client is enabled on the configuration.
It is recommended as a best practice to add the base URI under HTTP client.
The second configuration shows how we can modify the header as per our requirement with ease by using key-value pairs to extend the base header.
The + symbol allows for multiple entries to the header using the same configuration space.
Add Authentications to use
Authentication can be set up either directly or the HTTP Client or by first creating the HTTP Authentications entity.
Setting up the HTTP Authentication on the HTTP Client
Simply select the required Authentication type (Outh2 authentication in the example), and provide the authentication information as requested on the dashboard. The checkboxes marked with a red asterisk (*) are mandatory fields.
Here, the Authentication is created as a separate configuration under the HTTP Authentications configurations. The created Authentication entity is referred to in the HTTP Client to provide the necessary link between the Client and its Authentication.
An example of this configuration strategy is as shown below.
How to use the Http Client
The HTTP client configuration created can be reused in an instance where an HTTP call is being made through the dashboard.
Conveniently the end-user will also encounter HTTP client configuration dropdown wherever might be necessary.
For example, below is an instance where the incoming configuration is invoking a GET API call.