Configuring REST API connector – Digest Auth

The Studio provides you with several Connectors like Databases like MySQL, Microsoft SQL, etc., and Third-party connectors like Slack, Trello, Stripe, etc. You can connect the different APIs using their respective authentication methods. There are different methods of API authentication, using the API Key, using basic Auth which is using the username and password, using the OAuth which is a standard for accessing user permissions without a password, the AWS authentication method, and the digest authentication method similar to basic auth.

The Digest Authentication method is quite similar to Basic Auth based on username and password. We use Digest Auth mainly in the scenario where our API rely on the HTTP “Digest” Authentication standard.

It is one of the standard methods utilized by an Internet server to verify the credentials of a client. Credentials are hashed prior to being sent, guaranteeing they are never communicated in clear message structure.

Configuring the third-party API connector

To add third-party connectors, under Studio > Connectors, click (+) Connector.

image

Studio has different options including the use of the REST API that allows you to easily connect to the Third-Party API and database and access important systems. It has a digest authentication feature.

Configure API Category

When configuring the APIs you need to provide the Authentication details for the respective authentication method. Let us see how to configure an API using the digest authentication method.
Once you select the REST API, enter the Connector name which should ideally be self-explanatory.
In the Authentication section, select Digest Authentication.

Configure environment-specific fields

The two main parameters that can be used for digest authentication are the username and password . The Default value field can be hardcoded. By assigning a default value it will be used instead of missing or null values every time the service runs.

If other details like the subdomain or team name, API Key are required for authentication in addition to username and password, you just need to add them using Advance > Query String parameters or the Advance> Headers under test API configuration

Once the configuration settings are done you need to configure a Test request. A simple API endpoint that would allow you to check the user credentials is to be added. Under Response, you would see the success code or the response values from your respective API.

In the above image, we have used MongoDB service as the endpoint API and its credentials.

When the request is successful it will show the respective message. Click Save and the process is complete.

Add API

You can now add APIs based on the Connector configuration. Under Studio > Connectors you can see your connector is added. To add your new API as per the API endpoint, click Add API .

Now Add the Connector API name and the API endpoint with the required parameters and test your API.

Managing Environment

You can select the Manage Environment option from the edit button of the configured connector. Here you can manage different environments such as production, staging, development, test environment, and others, of a single account by adding different credentials and other details corresponding to different environments.

image

Select either the environments which you haven’t configured yet, by clicking on configure or clicking on the configured environments to make further changes and edits.
You will see that the environments which are yet to be configured already have the base URL of your API endpoint for the given environment. You can make changes from a single place and these changes will reflect on your respective environments.

Once done, click on Save .