We are now aware of using the REST API using the different authentication methods like OAuth 2.0, API keys and so on. There are some APIs that allow you to send requests to a remote data set without having to use any Authentication method. The response is delivered to your own application in a standardized format. For example, many weather apps get their weather forecast data often have access to a common weather API which is commonly an OPEN API with no authentication method associated. Though this is not a very secure way, it can be useful when such public apps need datasets with little risk of tampering.
Let us now understand how to use the NoAuth APIs.
To add third party connectors, under Studio > Connectors, click (+) Connector.
Studio has different options including the use of the REST API that allows you to easily connect to the Third Party API access to important systems. We will be selecting the REST API for this example.
To configure an API you typically need to configure an API Category, Manage an Account and then add the respective API.
Configure API Category
You first need to provide the details of your API Category, thus enter a Category name and Category description. Add an appropriate icon and click Continue.
Now select the type of Authentication that you want to use. Here we are going to use the option NoAuth and click Continue.
Now you need to provide the configuration parameter required by the specific API if any. In this example here we are referring to a weather API from 7timer.info which is open and does not need any authentication. Now provide a method for example a GET method is used here to get the data of the weather conditions and click Continue to test the configuration.
Once the configuration settings are done you need to Test the endpoint.
This way you would be adding the necessary parameter and testing the configuration. Under Response you would see the response values from your respective API. When the request is successful it will show the respective message.
Click Continue and the process is complete.
Your API can be seen under Custom API Connectors now. You can now see the API under UI Builder and view the parameters available.
Add API to configure
Now that you have configured the API category, you now need to add the API for configuration. Under Studio > Connectors > Custom API Connectors you can see your connector is added. To add this API, click Add API.
Now Add the Service Name, the Method as GET method and the URL (the weather Open API available has been added here as an example) . In this case you are choosing a GET method as shown below:
Under Configuration, there are Request, Response and Preselect Query configurations which you can add depending upon your API. Note that under Authentication, you can see Type of authentication: No Authentication.
Once you have configured the API as required, you can click Test and Save. You can check the response accordingly to your request. The API is now added successfully to your Custom API connectors.
In response for this example, you would find the weather records for different places.
You can refer to this link here to understand how to use the API services.