* Source Strava: http -> https * Source Strava: update docs * Source Strava: update docs * Source Strava: update docs * Source Strava: add allowed hosts * Automated Change * Source Strava: add date-time format * Source Strava: add date-time format * auto-bump connector version --------- Co-authored-by: artem1205 <artem1205@users.noreply.github.com> Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
127 lines
6.2 KiB
Markdown
127 lines
6.2 KiB
Markdown
# Strava
|
|
|
|
This page guides you through the process of setting up the Strava source connector.
|
|
|
|
## Prerequisites
|
|
|
|
Scopes:
|
|
* `activity:read_all`
|
|
|
|
## Setup guide
|
|
### Step 1: Set up Strava
|
|
|
|
<!-- env:oss -->
|
|
**For Airbyte Open Source:**
|
|
|
|
Follow these steps to get the required credentials and inputs:
|
|
* `client_id` and `client_secret`
|
|
* [Create a Strava account](https://developers.strava.com/docs/getting-started/#account)
|
|
* Continue to follow the instructions from the doc above to obtain `client_id` and `client_secret`
|
|
* `refresh_token`
|
|
* Enter this URL into your browser (make sure to add your `client_id` from previous step:
|
|
* `https://www.strava.com/oauth/authorize?client_id=[REPLACE_WITH_YOUR_CLIENT_ID]&response_type=code&redirect_uri=https://localhost/exchange_token&approval_prompt=force&scope=activity:read_all`
|
|
* Authorize through the UI
|
|
* Browser will redirect you to an empty page with a URL similar to `https://localhost/exchange_token?state=&code=b55003496d87a9f0b694ca1680cd5690d27d9d28&scope=activity:read_all`
|
|
* Copy the authorization code above (in this example it would be `b55003496d87a9f0b694ca1680cd5690d27d9d28`)
|
|
* Make a cURL request to exchange the authorization code and scope for a refresh token:
|
|
* ```
|
|
curl -X POST https://www.strava.com/oauth/token \
|
|
-F client_id=YOUR_CLIENT_ID \
|
|
-F client_secret=YOUR_CLIENT_SECRET \
|
|
-F code=AUTHORIZATION_CODE \
|
|
-F grant_type=authorization_code
|
|
```
|
|
* The resulting json will contain the `refresh_token`
|
|
* Example Result:
|
|
* ```
|
|
{
|
|
"token_type": "Bearer",
|
|
"expires_at": 1562908002,
|
|
"expires_in": 21600,
|
|
"refresh_token": "REFRESHTOKEN",
|
|
"access_token": "ACCESSTOKEN",
|
|
"athlete": {
|
|
"id": 123456,
|
|
"username": "MeowTheCat",
|
|
"resource_state": 2,
|
|
"firstname": "Meow",
|
|
"lastname": "TheCat",
|
|
"city": "",
|
|
"state": "",
|
|
"country": null,
|
|
...
|
|
}
|
|
}
|
|
```
|
|
* Refer to Strava's [Getting Started - Oauth](https://developers.strava.com/docs/getting-started/#oauth) or [Authentication](https://developers.strava.com/docs/authentication/) documents for more information
|
|
* `athlete_id`
|
|
* Go to your athlete page by clicking your name on the [Strava dashboard](https://www.strava.com/dashboard) or click on "My Profile" on the drop down after hovering on your top bar icon
|
|
* The number at the end of the url will be your `athlete_id`. For example `17831421` would be the `athlete_id` for https://www.strava.com/athletes/17831421
|
|
|
|
<!-- /env:oss -->
|
|
|
|
<!-- env:cloud -->
|
|
**For Airbyte Cloud:**
|
|
|
|
* `athlete_id`
|
|
* Go to your athlete page by clicking your name on the [Strava dashboard](https://www.strava.com/dashboard) or click on "My Profile" on the drop down after hovering on your top bar icon
|
|
* The number at the end of the url will be your `athlete_id`. For example `17831421` would be the `athlete_id` for https://www.strava.com/athletes/17831421
|
|
|
|
<!-- /env:cloud -->
|
|
|
|
|
|
### Step 2: Set up the source connector in Airbyte
|
|
|
|
<!-- env:cloud -->
|
|
**For Airbyte Cloud:**
|
|
|
|
1. [Log into your Airbyte Cloud](https://cloud.airbyte.com/workspaces) account.
|
|
2. In the left navigation bar, click **Sources**. In the top-right corner, click **+ new source**.
|
|
3. On the source setup page, select **Strava** from the Source type dropdown and enter a name for this connector.
|
|
4. lick `Authenticate your account`.
|
|
5. Log in and Authorize to the Strava account
|
|
6. Set required **Athlete ID** and **Start Date**
|
|
7. click `Set up source`.
|
|
<!-- /env:cloud -->
|
|
|
|
<!-- env:oss -->
|
|
**For Airbyte Open Source:**
|
|
|
|
1. Go to local Airbyte page.
|
|
2. In the left navigation bar, click **Sources**. In the top-right corner, click **+ new source**.
|
|
3. On the source setup page, select **Strava** from the Source type dropdown and enter a name for this connector.
|
|
4. Add **Client ID**, **Client Secret** and **Refresh Token**
|
|
5. Set required **Athlete ID** and **Start Date**
|
|
6. Click `Set up source`.
|
|
<!-- /env:oss -->
|
|
|
|
## Supported sync modes
|
|
|
|
The Strava source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes):
|
|
|
|
- [Full Refresh - Overwrite](https://docs.airbyte.com/understanding-airbyte/connections/full-refresh-overwrite/)
|
|
- [Full Refresh - Append](https://docs.airbyte.com/understanding-airbyte/connections/full-refresh-append)
|
|
- [Incremental Sync - Append](https://docs.airbyte.com/understanding-airbyte/connections/incremental-append)
|
|
- [Incremental Sync - Deduped History](https://docs.airbyte.com/understanding-airbyte/connections/incremental-deduped-history)
|
|
|
|
## Supported streams
|
|
|
|
* [Athlete Stats](https://developers.strava.com/docs/reference/#api-Athletes-getStats)
|
|
* [Activities](https://developers.strava.com/docs/reference/#api-Activities-getLoggedInAthleteActivities) \(Incremental\)
|
|
|
|
## Performance considerations
|
|
|
|
Strava API has limitations to 100 requests every 15 minutes, 1000 daily.
|
|
More information about Strava rate limits and adjustments to those limits can be found [here](https://developers.strava.com/docs/rate-limits).
|
|
|
|
## Changelog
|
|
|
|
| Version | Date | Pull Request | Subject |
|
|
|:--------|:-----------|:---------------------------------------------------------|:-----------------------------------------------------------|
|
|
| 0.1.4 | 2023-03-23 | [24368](https://github.com/airbytehq/airbyte/pull/24368) | Add date-time format for input |
|
|
| 0.1.3 | 2023-03-15 | [24101](https://github.com/airbytehq/airbyte/pull/24101) | certified to beta, fixed spec, fixed SAT, added unit tests |
|
|
| 0.1.2 | 2021-12-15 | [8799](https://github.com/airbytehq/airbyte/pull/8799) | Implement OAuth 2.0 support |
|
|
| 0.1.1 | 2021-12-06 | [8425](https://github.com/airbytehq/airbyte/pull/8425) | Update title, description fields in spec |
|
|
| 0.1.0 | 2021-10-18 | [7151](https://github.com/airbytehq/airbyte/pull/7151) | Initial release supporting Strava API |
|
|
|