27b33d890d
* adding datascope connector * fixing tests * fixing readme * cleanup * adding incremental streams * correct tests * fixing non incremental streams * dropping incremental for some streams * update date cursor for incremental * rename parameters * correct integrqation test files * remove files * update start date example * add datascope to source def * add eof * auto-bump connector version Co-authored-by: marcosmarxm <marcosmarxm@gmail.com> Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
64 lines
2.1 KiB
Markdown
64 lines
2.1 KiB
Markdown
# DataScope
|
|
|
|
This page contains the setup guide and reference information for the [DataScope](https://dscope.github.io/docs/) source connector.
|
|
|
|
## Prerequisites
|
|
|
|
A DataScope account with access to the API. You can create a free account [here](https://www.mydatascope.com/webhooks).
|
|
|
|
|
|
## Setup guide
|
|
|
|
### Step 1: Set up DataScope connection
|
|
|
|
- Create a DataScope account
|
|
- Create an API key and copy it to Airbyte
|
|
|
|
## Step 2: Set up the DataScope connector in Airbyte
|
|
|
|
### For Airbyte Cloud:
|
|
|
|
1. [Log into your Airbyte Cloud](https://cloud.airbyte.io/workspaces) account.
|
|
2. In the left navigation bar, click **Sources**. In the top-right corner, click **+new source**.
|
|
3. On the Set up the source page, enter the name for the DataScope connector and select **DataScope** from the Source type dropdown.
|
|
4. Enter your `api_key`.
|
|
5. Enter the params configuration if needed. Supported params are: sort, alt, prettyPrint (Optional)
|
|
6. Click **Set up source**.
|
|
|
|
### For Airbyte OSS:
|
|
|
|
1. Navigate to the Airbyte Open Source dashboard.
|
|
2. Set the name for your source.
|
|
3. Enter your `api_key` which will be flagged with Authorization header.
|
|
6. Click **Set up source**.
|
|
|
|
## Supported sync modes
|
|
|
|
The DataScope source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes):
|
|
|
|
| Feature | Supported? |
|
|
| :---------------------------- | :--------- |
|
|
| Full Refresh Sync | Yes |
|
|
| Incremental Sync | No |
|
|
| Replicate Incremental Deletes | No |
|
|
| SSL connection | Yes |
|
|
| Namespaces | No |
|
|
|
|
## Supported Streams
|
|
|
|
- Locations
|
|
- answers
|
|
|
|
Implemented but not added streams:
|
|
- Lists
|
|
- Notifications
|
|
|
|
## API method example
|
|
|
|
GET https://www.mydatascope.com/api/external/locations
|
|
|
|
## Changelog
|
|
|
|
| Version | Date | Pull Request | Subject |
|
|
| :------ |:-----------|:----------------------------------------------------------| :------------- |
|
|
| 0.1.0 | 2022-10-31 | [#18725](https://github.com/airbytehq/airbyte/pull/18725) | Initial commit | |