HTTP Emitter
The HTTP target can emit the extracted or transformed data to HTTP and HTTPS resources.
HTTP Emitter Configuration
To add an HTTP emitter into your pipeline, drag the emitter on the canvas and connect it to a Data Source or processor. The configuration settings of the HTTP emitter are as follows:
| Field | Description |
|---|---|
| URI | HTTP or HTTPS URI to send request to a resource. The URL defined can either be provided with actual values or can be parameterized. The placeholders in case of parameterized inputs will be resolved during runtime as per the value of column name existing in the URL. Example: http://localhost:1234/${column-name-1}/{column-name-2} |
| Method Type | You can choose a request method type based on the HTTP URL. The following method types are supported: GET: Use this method to retrieve information from the given server using a URI. The GET requests will only retrieve data without having any other effect on the data. POST: Use this method to send data to the server using HTML forms. PUT: Use this method to replace all current representations of the target resource with the uploaded content. DELETE: Use this method to remove all current representations of the target resource given by a URI. In POST, PUT and DELETE, the user provides the request body in the below format: {'key':'value'} |
| Enable SSL | This option can be selected as True if SSL is enabled on Http. It is set to False by default. If selected as true, keystore/certificate file needs to be uploaded or the keystore file path should be provided in the respective configuration fields. |
| Keystore select option | Option to choose between a certificate file or a keystore file that you will need to upload for authenticating SSL connectivity. |
| Header | Header’s parameter name and value. |
| Accept Type | The content type that the URI accepts should be selected out of JSON, CSV or Text. |
| Auth Type | Used to specify the authorization type associated with the URL. Includes None, Basic, Token and OAuth2 as authorization types. All the types are explained below in detail. None: This option specify that URL can be accessed without any authentication. Basic: This option specify that accessing URL requires Basic Authorization. Provide user name and password for accessing the URL. Token Based: Token-based authentication is a security technique that authenticates the users who attempts to log in to a server, a network, or other secure system, using a security token provided by the server. Oauth2: It is an authentication technique in which application gets a token that authorizes access to the user’s account. |
If Auth Type is selected as Basic, proceed by providing inputs for below parameters:
| Username | Enter the user name for accessing the URI. |
| Password | Enter the password for accessing the URl. |
If Auth Type is selected as Token, proceed by providing inputs for below parameters:
| Token ID | Key with which token is referred in request. |
| Token | Token which is provided in order to access the URL. |
If Auth Type is selected as OAuth2, proceed by providing inputs for below parameters:
| Client ID | Client ID identifier, given to client during application registration process. |
| Secret Key | The secret key provided to the client during application registration process. |
| Auth URL | The endpoint for authorization server, which retrieves authorization code. |
| Header | Used to specify the headers associated with Auth Url, through which authorization code is generated. |
After providing the details for the selected Auth Type, continue to configure the HTTP Emitter.
| Message Name | The name of the message configuration which will act as a metadata for the actual data. |
| Output Fields | Fields that need to be a part of the output data should be selected. Make sure that the column(s) existing in the URL should be selected in the output fields. For creating a customized payload, please use the Custom Payload option. |
| Custom Payload | Option to provide the customized payload. |
| Payload | Provide the payload in the format that supports the Accept Type field. Example: If Accept Type field is selected as JSON, then provide the payload as per the sample given below: {“emp_id” : ${id}, “emp_name” : $name} will be evaluated to {“emp_id” : 1, “emp_name” : John} |
| Enable Request Rate | Control the rate at which HTTP calls are made on each partition. The HTTP calls are made in parallel on multiple partitions. Therefore, set the number of partitions using the repartition processor before using the HTTP emitter. Example: For a client, the API hit rate limit is set to 40 calls/sec. Add a repartition processor before HTTP emitter and provide the partitioning value as 10. Now, set the rate limit to 4 requests per second, which will apply to each partition. This means 10 parallel partitions will be working with 4 requests per second on each partition allowing 40 requests per second on the HTTP emitter. |
If you have any feedback on Gathr documentation, please email us!