76df2f240a
* updated_links_in_docs * updated more links * typo * removed backticks * deleted links in deploying on cloud and local deployment
50 lines
1.6 KiB
Markdown
50 lines
1.6 KiB
Markdown
# Orbit
|
|
|
|
## Sync overview
|
|
|
|
This source can sync data for the [Orbit API](https://docs.orbit.love/reference/about-the-orbit-api). It currently only supports Full Refresh syncs.
|
|
|
|
### Output schema
|
|
|
|
This Source is capable of syncing the following core Streams:
|
|
|
|
* [Members](https://api.orbit.love/reference/get_workspace-slug-members)
|
|
* [Workspaces](https://docs.orbit.love/reference/get_workspaces-workspace-slug)
|
|
|
|
### Features
|
|
|
|
| Feature | Supported?\(Yes/No\) | Notes |
|
|
| :--- | :--- | :--- |
|
|
| Full Refresh Sync | Yes | |
|
|
| Incremental Sync | No | |
|
|
| Namespaces | No | |
|
|
| Pagination | Yes | |
|
|
|
|
### Performance considerations / Rate Limiting
|
|
|
|
The Orbit API is rate limited at 120 requests per IP per minute as stated [here](https://docs.orbit.love/reference/rate-limiting).
|
|
|
|
Please [create an issue](https://github.com/airbytehq/airbyte/issues) if you see any rate limit issues that are not automatically retried successfully.
|
|
|
|
## Getting started
|
|
|
|
### Requirements
|
|
|
|
* Orbit API key - This can either be a workspace-tied key or a general personal key.
|
|
|
|
### Setup guide
|
|
|
|
The Orbit API Key should be available to you immediately as an Orbit user.
|
|
|
|
1. Head to app.orbit.love and login to your account.
|
|
2. Go to the **Settings** tab on the right sidebar.
|
|
3. Navigate to **API Tokens**.
|
|
4. Click **New API Token** in the top right if one doesn't already exist.
|
|
|
|
## Changelog
|
|
|
|
| Version | Date | Pull Request | Subject |
|
|
| :--- | :--- | :--- | :--- |
|
|
| 0.1.1 | 2022-06-28 | [14208](https://github.com/airbytehq/airbyte/pull/14208) | Remove unused schema |
|
|
| 0.1.0 | 2022-06-27 | [13390](https://github.com/airbytehq/airbyte/pull/13390) | Initial Release |
|