Demo to preview the plugin:
Introduction
This plugin for Algolia facilitates quick data management to and from the Algolia platform using CSV files. With this solution, you can upload large datasets directly from a CSV file into Algolia, ensuring that information is correctly structured and synchronized with the search engine.
How to setup
1. Log In to the Algolia Dashboard
- Access the Algolia dashboard at Algolia Dashboard and log in to your account.
2. Navigate to the API Keys Section
- From the left-hand menu, go to API Keys.
- Here, you'll find all existing keys, including the default ones like
Admin API Key
andSearch API Key
.
3. Create a New API Key (Optional)
If you want to create a new key with custom permissions:
- Click on Create API Key.
- Fill in the details:
- Description: Provide a name, e.g., "Admin Key for XYZ Project".
- ACL (Access Control List): Select the required permissions. For an Admin Key, enable all permissions:
search
addObject
deleteObject
editSettings
analytics
logs
- Indexes: Specify the indexes this key should apply to, or leave it empty for all indexes.
- Validity: Optionally set an expiration date for the key.
- IP Restrictions: Add IP restrictions for enhanced security (optional).
- Referrer Restrictions: Add referrer restrictions if required.
- Click Save to finalize the creation of the key.
4. Copy the Admin API Key
5. Take the copied keys and go to them in the "Plugin" section of your Bubble application, then configure the keys in the plugin settings.
Plugin Actions
Import CVS
Import CVS - Import CSV: This action helps you import a CSV file into Algolia, into the index you specify.
Title | Description | Type |
Index Name | The name of the Algolia index where the objects will be saved. It must exactly match the name of the existing index in your Algolia account to ensure that the data is loaded correctly. | Text |
CSV URL | The URL to the CSV file that the plugin will retrieve and process to load data into Algolia. This field accepts a dynamic value, so the user can specify a URL generated at runtime. | Text |
Return Values:
Title | Description | Type |
ObjectIDs | These are the IDs of the new objects created in the Algolia index. | List of Text |
Export CVS
Export CVS - Exports a CSV file from your Algolia index.
Title | Description | Type |
Index Name | The name of the Algolia index where the objects will be saved. It must exactly match the name of the existing index in your Algolia account to ensure that the data is loaded correctly. | Text |
Website Home URL | The base URL of the website where the file upload endpoint is located. This URL will be used to construct the full endpoint for uploading the CSV file. | Text |
File Name | The desired name of the file that will be created and uploaded. This name will be used to label the file in the file manager, and it should include a relevant identifier or timestamp if unique naming is required. | Text |
Return Values:
Title | Description | Type |
File URL | This is the link to the CSV file you want to export. | Text |
Status | The status of the operation. | Text |