Active |
---|
This application does not need additional settings. So you can make connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). only by using your login credentials or by following the instructions below . |
With HTTP Agent modulesa module is an application or tool designed to handle specific business functions, such as CRM, project management, or inventory. The system's modular architecture allows you to activate only the modules you need, enabling customization and scalability as your business requirements evolve. in Boost.spaceA platform that centralizes and synchronizes company data from internal and external sources, offering a suite of modules and addons for project management, CRM, data visualization, and more. Has many features to optimize your workflow! IntegratorPart of the Boost.space system, where you can create your connections and automate your processes., you can connect to your On-prem agent and make HTTP(S) requests, including for resources that require HTTP Basic and API Key authorizations.
Note | |
---|---|
To use HTTP Agent modules in Make, you must have the Boost.space Integrator Enterprise plan. HTTP Agent modules are only used with the On-prem agent. The On-prem agent must be installed with a connected system configured to use HTTP Agent modules. Refer to the Using the On-premise agent documentation for instructions on how to do so. |
The HTTP Agent modulea module is an application or tool designed to handle specific business functions, such as CRM, project management, or inventory. The system's modular architecture allows you to activate only the modules you need, enabling customization and scalability as your business requirements evolve. you should use depends upon the authentication/authorization mechanism of the resource you wish to access:
-
Make a Request – universal module, best to use for resources that do not require authentication.
-
Make an API Key Auth Request – for resources that require API key authentication.
-
Make a Basic Auth Request – for resources that require basic authentication.
Establishing a connection to the HTTP Agent in Boost.space Integrator differs for each HTTP Agent module, depending on the authorization type. Follow the connection procedure below and insert the specific information for the HTTP Agent module you want to connect to.
Note | |
---|---|
You must already have a connected system configured in your On-prem agent to establish a connection to the HTTP Agent modules in Boost.space Integrator. |
-
Log in to your Boost.space Integrator account, add the HTTP Agent module with the desired authorization type to your scenarioA specific connection between applications in which data can be transferred. Two types of scenarios: active/inactive., and click Create a Connection.
-
Optional: In the Connection Name field, enter a name for the connection.
-
In the Connected System dropdown, select the relevant connected system from your On-prem agent.
Tip You can always check which connected system is associated with the specific On-prem agent in the On-prem agents section, on the Organization dashboard.
-
Depending on the HTTP Agent module you have selected, input the following:
Module
Field
Input
Make a Request
–
–
Make an API Key Auth Request
API Key
Paste your API key from the 3rd party account of the connected system you chose. Refer to the specific system’s documentation on how to generate an API key.
Placement
Select whether the API key will be placed as a header or as a query parameter.
API Key Parameter Name
Enter a name for the API key parameter.
Make a Basic Auth Request
Username
Enter your account username for your 3rd party account of the connected system you chose.
Password
Enter your account password for your 3rd party account of the connected system you chose.
-
Click Save.
You have successfully established the connection. You can now edit your scenario and add more HTTP Agent modules. If your connection requires reauthorization at any point, follow the connection renewal steps here.
With HTTP Agent Modules in Boost.space Integrator, you can send HTTP(S) requests to specified URLs, including those that require Basic Auth and API Key Auth authorizations, and process the responses.
Send an HTTP(S) request to a specified URL and process the response. The received HTTP(S) response is then contained in the output bundleA bundle is a chunk of data and the basic unit for use with modules. A bundle consists of items, similar to how a bag may contain separate, individual items. .
Connection |
|||||||||||
URL |
Enter the connected system request URL. |
||||||||||
Method |
Select or map the HTTP method you want to use: GET to retrieve information for an entry. HEAD to retrieve headers. POST to create an entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry. OPTIONS to retrieve communication options. |
||||||||||
Headers |
Enter or map desired request headers. For example, an authorization. By default, the request does not contain the |
||||||||||
Query String |
Enter or map the desired query key-value pairs. |
||||||||||
Body Type |
|
||||||||||
Parse Response |
Enable this option to automatically parse responses and convert JSON responses so you don’t need to use the JSON > Parse JSON module. Note: Before you can use parsed content, run the module once manually so that the module can recognize the response content and allow you to map it in subsequent modules. |
Send an HTTP(S) request to a specified URL that requires API Key Auth authorization and process the response. The received HTTP(S) response is then contained in the output bundle.
Connection |
|||||||||||
URL |
Enter the connected system request URL. |
||||||||||
Method |
Select or map the HTTP method you want to use: GET to retrieve information for an entry. HEAD to retrieve headers. POST to create an entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry. OPTIONS to retrieve communication options. |
||||||||||
Headers |
Enter or map desired request headers. For example, an authorization. By default, the request does not contain the |
||||||||||
Query String |
Enter or map the desired query key-value pairs. |
||||||||||
Body Type |
|
||||||||||
Parse Response |
Enable this option to automatically parse responses and convert JSON responses so you don’t need to use the JSON > Parse JSON module. Note: Before you can use parsed content, run the module once manually so that the module can recognize the response content and allow you to map it in subsequent modules. |
||||||||||
Timeout |
Specify the request timeout in seconds (1-300). Default: 300 seconds. This value controls two timeouts: Read timeout and Connection timeout. Read timeout is a time to wait for a server to send response headers (and start the response body) before aborting the request. Connection timeout sets the socket to timeout after timeout milliseconds of inactivity. |
Send an HTTP(S) request to a specified URL that requires Basic Auth authorization and process the response. The received HTTP(S) response is then contained in the output bundle.
Connection |
|||||||||||
URL |
Enter the connected system request URL. |
||||||||||
Method |
Select or map the HTTP method you want to use: GET to retrieve information for an entry. HEAD to retrieve headers. POST to create an entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry. OPTIONS to retrieve communication options. |
||||||||||
Headers |
Enter or map desired request headers. For example, an authorization. By default, the request does not contain the |
||||||||||
Query String |
Enter or map the desired query key-value pairs. |
||||||||||
Body Type |
|
||||||||||
Parse Response |
Enable this option to automatically parse responses and convert JSON responses so you don’t need to use the JSON > Parse JSON module. Note: Before you can use parsed content, run the module once manually so that the module can recognize the response content and allow you to map it in subsequent modules. |
||||||||||
Timeout |
Specify the request timeout in seconds (1-300). Default: 300 seconds. This value controls two timeouts: Read timeout and Connection timeout. Read timeout is a time to wait for a server to send response headers (and start the response body) before aborting the request. Connection timeout sets the socket to timeout after timeout milliseconds of inactivity. |