airbyte/airbyte-integrations/connectors/source-algolia

Algolia

This directory contains the manifest-only connector for source-algolia.

Documentation reference:

Visit https://www.algolia.com/doc/rest-api/search/ for API documentation

Authentication setup

Source-algolia uses API keys and application id for its authentication, Visit https://dashboard.algolia.com/account/overview for getting credentials and application id. Visit https://www.algolia.com/doc/rest-api/search/#section/Authentication for more about authentication.

Usage

There are multiple ways to use this connector:

• You can use this connector as any other connector in Airbyte Marketplace.
• You can load this connector in pyairbyte using get_source!
• You can open this connector in Connector Builder, edit it, and publish to your workspaces.

Please refer to the manifest-only connector documentation for more details.

Local Development

We recommend you use the Connector Builder to edit this connector.

But, if you want to develop this connector locally, you can use the following steps.

Environment Setup

You will need airbyte-ci installed. You can find the documentation here.

Build

This will create a dev image (source-algolia:dev) that you can use to test the connector locally.

airbyte-ci connectors --name=source-algolia build

Test

This will run the acceptance tests for the connector.

airbyte-ci connectors --name=source-algolia test