API Integration
Last updated
Last updated
API integration in Hubler refers to the capability of the platform to connect and communicate with external systems, applications, or services using APIs (Application Programming Interfaces). API integration allows Hubler to exchange data, functionality, and services with other software or platforms seamlessly.
The data can be either displayed on the front or stored in the backend to be used later.
Data Fetch from API Sections:
Basic Details:
URL: This field is utilized for entering the API's URL.
Method: Use this option to specify the method employed when configuring the API (POST, GET, PUT, PATCH, or DELETE).
Query Parameters: Query parameters serve as placeholders that can be replaced with specific values during runtime. By utilizing query parameters, users can create dynamic and flexible queries that adapt to different contexts or user inputs.
This feature enhances the versatility and customization options within Hubler applications, enabling users to retrieve and manipulate data based on specific criteria or conditions.
Authorization:
Authorization Type: This setting is utilized to configure the authorization details as No Auth, Basic, API Key, and Bearer Token.
No Auth: Select this option when no authorization is required to access the data.
Basic: Choose this option when accessing the data necessitates providing basic API information along with a unique code.
API Key: This option is selected for a higher level of authorization, where an API key is assigned. The data can be accessed only when the provided key matches the API key.
Bearer Token: This method generates a unique token for each data access request to verify the authenticity of the request. It involves two API calls: the first is a pre-request call to obtain the unique token, and the second is the data access call, where the received token from the first call is provided.
Headers: In Hubler API integration header encompass additional information included in the HTTP request headers when communicating with the Hubler API. These headers contain essential details and instructions for the API server, providing enhanced control and customization of API requests.
Body: In Hubler API integration, the "Body" denotes the data payload included in the HTTP request when communicating with the Hubler API. The request body carries the information or parameters required to execute specific actions or operations. The structure and content of the request body rely on the API endpoint and the intended functionality, typically comprising structured data like JSON or XML adhering to the API's defined schema or format.
Pre-Request: The Pre-Request feature allows for sending a preliminary request to retrieve a token or perform authentication before initiating the data access request.
The Pre-Request can be further configured by clicking on the gear icon and defining the Basic details, Authorization, and Headers.
Response: In Hubler API integration, the "Response" signifies the data provided by the Hubler API server in response to an HTTP request. This data encapsulates the outcome or result of the requested operation or action.
The response typically includes an HTTP status code, which indicates the success or failure of the request. Common status codes include 200 for a successful request, 400 for a client-side error, and 500 for a server-side error.
Response Fields:
Define Success Conditions: Use this option to establish the success condition for the API request.
Assign Values from Response: Utilize this feature to assign values received from the response.
Define Error Message: Employ this functionality to define the error message in the event of a failed API request. It assists in specifying the location and format of the error.