328fd8703e
Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
39 lines
1.4 KiB
Markdown
39 lines
1.4 KiB
Markdown
# Survicate
|
|
This directory contains the manifest-only connector for `source-survicate`.
|
|
|
|
## Documentation reference:
|
|
Visit `https://developers.survicate.com/data-export/setup/` for API documentation
|
|
|
|
## Authentication setup
|
|
|
|
Survicate uses API Key Authorization, Please visit `https://panel.survicate.com/o/YOUR_ID/w/YOUR_WORKSPACE/settings/access-keys` for copying the access keys
|
|
Refer `https://developers.survicate.com/data-export/setup/#authentication` for more details.
|
|
|
|
## 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](airbyte-ci).
|
|
|
|
### Build
|
|
This will create a dev image (`source-survicate:dev`) that you can use to test the connector locally.
|
|
```bash
|
|
airbyte-ci connectors --name=source-survicate build
|
|
```
|
|
|
|
### Test
|
|
This will run the acceptance tests for the connector.
|
|
```bash
|
|
airbyte-ci connectors --name=source-survicate test
|
|
```
|