API Task
Contents
Overview
The API task feature in Infoveave allows you to interact with external or internal APIs and perform various actions such as retrieving data, creating new resources, updating existing resources, and more. With the ability to configure different request types, headers, form data, URL parameters, and authentication, you can easily set up API tasks to automate data retrieval and integration processes.
Set up API Task
- To set up an API Task, click on Automation Taks .
- All Tasks, those created by you or shared with you will be displayed under the tabs “My Task” and “Shared Task” respectively.
Note
- Use the search option to look for any existing Task.
- Use the Filter by option to filter the Task by type and mode.
- To switch the view between Card View and List View, click on the respective icons near to the search bar.
- To create a New Folder in Task, click on the Folder icon.
- To download the list of all existing Task, click on the Download icon. It delivers the details on (• Entity Id Name • Description • Content Tags • Created By • Created By User • Created On • Folder • Datasource Id • Datasource Name • Is Folder Public)
Configure API Task
To configure an API task in Infoveave, follow these steps:
- Click on “New Task” to set up a new task.
- Select the “API Task” option.
- Provide a name for the task (required).
- Choose whether to configure the task setting as plain text or in JSON format.
- Select the HTTP Request Method (required):
- Request Type: Select the desired HTTP request method from the dropdown list. Infoveave supports the following request types:
- GET: Retrieve data from a specified resource. It is commonly used to fetch information from APIs.
- POST: Send data to a server to create a new resource. It is used to submit data to APIs for creating records.
- PUT: Replace an existing resource with new data. It is used to update an entire resource with new information.
- PATCH: Update a part of an existing resource. It is used to make partial updates to a resource.
- DELETE: Delete a specified resource. It is used to remove a resource from the server.
- Custom APIs: This option allows for custom request types based on specific API requirements.
- Request Type: Select the desired HTTP request method from the dropdown list. Infoveave supports the following request types:
- Enter the required Request URL, which specifies the endpoint of the API you want to interact with (required).
- Define the content type as JSON or form-url-encoded, depending on the requirements of the API (required).
Alert
- Please note that the format you should use depends on the specific API's requirements. Some APIs may only accept JSON, while others may expect form-url-encoded data. Always refer to the API documentation or guidelines for the correct format to use.
Note
In this example, the request body contains key-value pairs that represent the user's information. Each key (name, email, password, age) corresponds to a specific field required by the API to create a user, and the corresponding value holds the actual data for each field. Remember that the structure and content of the request body can vary depending on the API and the specific operation you're performing. It's important to refer to the API documentation or guidelines to understand the expected format and data to include in the request body for a particular API request.
- Example of a Request Body in JSON format for creating a new user:
{
"name": "John Doe",
"email": "johndoe@example.com",
"password": "secretpassword",
"age": 30
}- Configure the headers by clicking on the “+” button. Headers provide additional information of Key and value to the API.
- Set up the Form Data by adding key-value pairs, by clicking on the “+” button, if necessary. Form Data allows you to send data in a structured format.
- Add the URL Parameters, by clicking on the “+” button, if applicable by providing key-value pairs in the designated section.
- Define any required Parameters for the API request.
- Configure the Body of the request, if needed, by specifying the necessary data in JSON format.
- If authentication is required, enter the Auth URL, Auth Request Type, Auth Headers, Client ID, and Client Secret in the corresponding fields.
- Click “Test” to run the API with your configuration and view the response in the preview side.
- Click “Save” to save the Task.
Tip
- To access any client API, it is necessary to include the Client ID and Client Secret in the header.
Sample: API Task Configuration
Sample
A sample API configuration in Infoveave:
- Task Name: Example API Task
- Request Type: POST
- Request URL: https://api.example.com/users/
- Content Type: JSON
- Headers: (Headers are like additional notes attached to an API request or response. They carry important information such as who is making the request, how to authenticate the request, and what kind of data is being sent or received.)
- Header 1:
- Key: Authorization
- Value: Bearer token123
- Header 2:
- Key: X-API-Key
- Value: abc123
- Header 1:
- Form Data: (Form data is a way to send structured information when interacting with an API. Think of it like filling out a form online. You provide specific pieces of data, like your name, email address, and other relevant details.)
- Key: Name
- Value: John Doe
- URL Params: (URL parameters are a way to include additional data in the URL of an API request. They are typically used to provide specific instructions or filters for the API to retrieve or manipulate data.)
- Parameter 1:
- Key: id
- Value: 1234
- Parameter 1:
- Parameters (Replacers for URL Parameters):
- Param 1: id (Replace with the actual value for the user ID)
- Body:
{ "name": "John Doe", "age": 30, "address": { "street": "123 Main St", "city": "New York" } }
Parameter Syntax: <<token>>