Authenticate the Web Service

In the Authentication Credentials section, select the Enable check box to enable Authentication Type, and additional required fields.

1. For Basic Authentication:

   1. From the Authentication Type list, select Basic.

   2. Enter the username and password in the respective fields.

      Select Show Password to view the password you entered.

2. For OAuth Authentication:

   3. From the Authentication Type list, select OAuth 2.0. You can select the Enable URL Encoding check box at the top to set URL encoding for REST OAuth 2.0 connections.

   4. This enables the Grant Type drop-down box.

      • If you select Password Credentials, enter the Username and Password in the Username and Password field respectively. If the client ID and client secret are required by the web service, enter the details in the Client Id and Client Secret fields.

      • If you select Client Credentials, the Username and Password field gets disabled. Enter the client ID and client secret details, in the Client Id and Client Secret fields respectively.

   5. If the token bearer string is provided by the web service, enter it in the Access Token field. You may ignore the other fields.

   6. If the token bearer string is not provided by the web service, enter the Authentication Server Address, User Name, and Password. If the client ID and client secret are required by the web service, enter the details in the Client ID and Client Secret fields.

      This enables the Request Token button.

   7. Select Request Token.

      • The token bearer number populates in the Access Token field.

   Note: Based on the authentication mode, the connection strings (web service address) may vary from the Authentication Server URL. For OAuth authentication, it is possible that the "Authentication Server Address" URL is a different URL than the one you actually use in the "Web Service Address" URL to interact with the web service. This is because the authentication is performed through one URL that assigns the bearer token, and the data exchange is performed in a different URL that allows the data exchange.

3. Custom Authentication:

   8. From the Authentication Type list, select Custom. You can select the Enable URL Encoding check box at the top if any special characters are mentioned in Username and Password fields (ex: user$%&* etc).

   9. Configure the relevant key-value pairs in the Header, Body, and Authentication grids.

      1. Header Parameters

         Header Name	Description	Example
         Authorization	Authentication Token	Bearer TEST_TOKEN_12345
         Content-Type	Request payload format	application/json
         Accept	Response format	application/json
         X-API-Key	API key (if required)	abcdef12345
         Custom Headers	Any additional required headers	As needed

      2. Body Parameters

         Parameter Name	Description	Example
         username	User identifier	abc
         password	User password	abc123
         client_id	OAuth client identifier	my-client-id
         client_secret	OAuth client secret	my-secret
         grant_type	OAuth grant type	password
         scope	Access scope	read write
         Custom Fields	Business-specific request fields	As required

      3. Authentication Configuration Parameters

         Parameter Name	Description	Example
         Cert File (optional)	File path to the client certificate used for authentication	C:\Users\...\express-oauth-service.pem
         Private Key (optional)	File path to the private key associated with certificate	C:\Users\...\express-oauth-private.key

         Note: You have to enter or paste the path to client certificate and private key in the Value column.

   10. If the token bearer string is not provided by the web service, enter the Authentication Server Address. This enables the Request Token button.

   11. Select Request Token.

       • The token bearer number populates in the Access Token field.

   12. Define the specific string used for the Bearer Token Type in the Token Prefix field. Some web server implementations are strictly case-sensitive and may require variations such as "Bearer", "bearer", or "BEARER".

   13. If the token bearer string is provided by the web service, enter it in the Access Token field. You may ignore the other fields.

   14. Set Token Refresh duration in minutes for the token to be automatically refreshed when the remaining time is below this duration.