A Connector Data Source links Quixy with external systems or APIs to fetch real-time data without storing it inside the platform. It is ideal for data that changes often, such as stock levels, account balances, or order details.
Unlike other Data Sources (Basic, Merged, or Query), a Connector always pulls live values from external systems each time a report, dashboard, or chart loads.
¶ 1. When to Use a Connector
Use a Connector when data stored in another system needs to be viewed or used within the platform. It’s ideal for information that changes often, such as sales, inventory, or customer details. The Connector fetches the latest values from the external source whenever you access a report, dashboard, or view.
Example:
Display live inventory from your ERP or customer details from your CRM.
¶ 2. Configuration
- Go to Admin Menu → Database → Create Data Source.
2. From the list of data source types, select Connector. This opens the configuration page.
3. Provide a unique name for your Connector Data Source.
4. Choose the Request Type: GET or POST, based on how the API should be called.
- GET – Retrieve data directly from an external API.
- POST – Send data or parameters in the request body to get specific results from the API.
Note:
Depending on your API, configure either a GET Request or a POST Request as explained below.
¶ 2.1. Configure GET Request
- Select Method Type: GET
- Choose the Authentication Type required by the API. For details, refer to the “Authentication” section in the External App Reference article.
- Add Custom Headers if needed
- Enter the API Endpoint (App Reference URL)
- Add search parameters in Value to Search if required
- Click Test URL to verify the connection. A success message appears if the API is connected successfully.
Example:
https://api.example.com/customers?customerId=12345
¶ 2.2. Configure POST Request
- Select Method Type: POST.
- Choose the Authentication Type required by the API.
- Add Custom Headers if needed.
- Enter the API Endpoint (App Reference URL).
- Choose how to send parameters:
- URL – Sends parameters directly in the URL.
Example:
https://api.example.com/addCustomer?name=John&city=Dallas
- Body – Sends parameters inside the request body, usually in JSON format.
Sample JSON:
{
"name": "John",
"city": "Dallas"
}
- Click Test URL to verify the connection. A success message appears if the API is connected successfully.
¶ 2.3. Map API Response
- After a successful connection, the response fields appear under Element Mapping.
- Each field from the API response is listed automatically.
- Rename fields using the Alias Name column for easier identification in reports and dashboards.
- Click Save to complete the setup.
¶ 3. Viewing Connector Data in the Data Source List
- On the Data Source List page, a Connector tag is shown beside the data source name, indicating it was created using an external connection.
- When you select the Connector Data Source and click View Records, the live data fetched from the external API is displayed in a tabular format.
Each row represents data pulled directly from the connected system in real time.
