The concept of an HTTP (Web) service is an open standard (JSON, XML, SOAP, HTTP, etc.) based web application that communicates with other web applications for the purpose of exchanging data.
In practice, using a protocol such as HTTP to transfer data in machine-readable file formats such as XML and JSON is a standardized way of providing interoperability between disparate applications.
In Synatic, the HTTP Service source step provides this function and generally allows the flow to send requests to read or get data from a web-based API.
Illustrated in the below image is a flow where the HTTP Service Source step is used.
Adding the HTTP Service Source Step
To add an HTTP Service Source step, follow the instructions below:
1. Click on the highlighted icon as shown in the below image to add the HTTP Service source step.
2. The below page will appear. Select or search for a Source step. Select HTTP Service as shown in the image below.
Configuring the HTTP Service Source step
The configuration for this step involves several options and settings as illustrated in the image below.
URL - Enter the URL of the HTTP Service.
HTTP Method - Select the HTTP Method to use. The two most common HTTP methods used are GET and POST. For more information on, click on the following link:
Authentication Method - A connection is required to create an Authentication Method. Click the plus (+) icon in red in the image to select and configure the HTTP Authentication type. The page below appears.
Provide a Connection Name. Click on the outlined dropdown list in the image below to select the Auth Type.
None - No authentication is required.
Basic - Requires a standard username and password.
O Auth1 - Access server resources on behalf of a resource owner (such as a different client or an end-user).
O Auth2 Client Credential - Secure access to server resources using without impersonating a user/resource owner.
Headers - Authorization headers.
Headers - Pass additional information with an HTTP request or response. Click the + icon to add any Headers you want to submit to the HTTP Service. Enter the headers you want to submit.
Name - Name of the header.
Value - Value of the header.
Paging - The paging option is used to set up how the data is rendered and controlled as retrieved from a web request. Select the Enabled checkbox to activate the paging criteria options. For more information, click on the link below:
Keep Headers Checkbox - Save the HTTP response headers to the headers field in the processing object. The metadata can be used for any specific purpose.
Retry - The Retry option is used to set an automatic retry of failed HTTP calls. Select the Enabled checkbox to activate the Retry options.
Times - Number of retry attempts.
Delay - Delay, in seconds, between attempts.
Follow Redirects checkbox - Instruct the HTTP Service step to obey and follow any redirect it might encounter when selected.
Relax SSL checkbox - Instruct the HTTP Service step to accept self-signed certificates that are otherwise rejected when selected.
Gzip Response checkbox - Set the response back to be compressed using Gzip when selected.
Enable Debug checkbox - Show debug results when selected.
Example
In this example, OAuth2 is selected as the Authentication Method as illustrated in the image below.
When selecting an Auth Type of oAuth2 in a typical HTTP Service request to an API, the following type of configuration may apply:
https://authorization-server.com/oauth?
response_type={code}
&client_id={CLIENT_ID}
&redirect_uri={"https://admin.synatic.com/app/public/oauthresponse"}
Configure the following fields with the correct values to process successful web requests:
Before beginning the OAuth process, first, register a new app with the service. In addition, register a redirect URI to be used for redirecting users to a web server.
OAuth Provider URL* - The OAuth2 provider URL to call for authentication.
OAuth Token URL* - The OAuth2 provider URL to generate tokens from.
Client ID* - The client id issued by the provider. After registering an app, a client ID is received with an optional a client secret.
Client Secret* - The client secret issued by the provider. The client secret must be kept confidential.
Response Type* - Select the Response type that the request will respond with as either a Code or a Token. This indicates that the server expects to receive an authorization code.
Grant Type* - Select the oAuth2 Grant type to use. Authorization Code is the available option for apps running on a web server, browser-based and mobile apps.
Use Refresh as Token - Use this option if the provider does not support refresh tokens but uses long-lived tokens.
One use Refresh Token - Use this option if the provider does not support using a refresh token more than once.
No Query String - Select this option to avoid sending parameters in the query string.
Scopes - A Scope is a mechanism in OAuth 2.0 that limits an application's access to a user's account. An application can request one or more scopes, and the access token issued to the application will be limited to the scopes granted.
Title - The display name.
Value - Value of the scope as defined by the provider.
Additional QS Values - Additional Query Strings (QS) to the HTTP Service request by adding parameters. The parameters will not be submitted if the No Query String checkbox is selected.
Name - Query string parameter.
Value - the query string value.
See Also
Read more about Source Steps here.
Useful Tutorials
Revisit the Getting Started page for a refresher.
Read more about Steps here.
Read other tutorials using the HTTP Service step: