* 5-step tutorial * move * tiny bit of editing * Update tutorial * update docs * reset * move files * record selector, request options, and more links * update * update * connector definition * link * links * update example * footnote * typo * document string interpolation * note on string interpolation * update * fix code sample * fix * update sample * fix * use the actual config * Update as per comments * write as yaml * typo * Clarify options overloading * clarify that docker must be running * remove extra footnote * use venv directly * Apply suggestions from code review Co-authored-by: Sherif A. Nada <snadalive@gmail.com> * signup instructions * update * clarify that both dot and bracket notations are interchangeable * Clarify how check works * create spec and config before updating connector definition * clarify what now_local() is * rename to yaml structure * Go through tutorial and update end of section code samples * fix link * update * update code samples * Update code samples * Update to bracket notation * remove superfluous comments * Update docs/connector-development/config-based/tutorial/2-install-dependencies.md Co-authored-by: Augustin <augustin.lafanechere@gmail.com> * Update docs/connector-development/config-based/tutorial/3-connecting-to-the-API-source.md Co-authored-by: Augustin <augustin.lafanechere@gmail.com> * Update docs/connector-development/config-based/tutorial/3-connecting-to-the-API-source.md Co-authored-by: Augustin <augustin.lafanechere@gmail.com> * Update docs/connector-development/config-based/tutorial/3-connecting-to-the-API-source.md Co-authored-by: Augustin <augustin.lafanechere@gmail.com> * Update docs/connector-development/config-based/tutorial/3-connecting-to-the-API-source.md Co-authored-by: Augustin <augustin.lafanechere@gmail.com> * Update docs/connector-development/config-based/tutorial/3-connecting-to-the-API-source.md Co-authored-by: Augustin <augustin.lafanechere@gmail.com> * Update docs/connector-development/config-based/tutorial/4-reading-data.md Co-authored-by: Augustin <augustin.lafanechere@gmail.com> * fix path * update * motivation blurp * warning * warning * fix code block * update code samples * update code sample * update code samples * small updates * update yaml structure * custom class example * language annotations * update warning * Update tutorial to use dpath extractor * Update record selector docs * unit test * link to contributing * tiny update * $ in front of commands * $ in front of commands * More readings * link to existing config-based connectors * index * update * delete broken link * supported features * update * Add some links * Update docs/connector-development/config-based/overview.md Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com> * Update docs/connector-development/config-based/record-selector.md Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com> * Update docs/connector-development/config-based/overview.md Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com> * Update docs/connector-development/config-based/overview.md Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com> * Update docs/connector-development/config-based/overview.md Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com> * mention the unit * headers * remove mentions of interpolating on stream slice, etc. * update * exclude config-based docs Co-authored-by: Sherif A. Nada <snadalive@gmail.com> Co-authored-by: Augustin <augustin.lafanechere@gmail.com> Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com>
50 lines
1.7 KiB
Markdown
50 lines
1.7 KiB
Markdown
# Getting Started
|
|
|
|
:warning: This framework is in alpha stage. Support is not in production and is available only to select users. :warning:
|
|
|
|
## Summary
|
|
|
|
Throughout this tutorial, we'll walk you through the creation an Airbyte source to read and extract data from an HTTP API.
|
|
|
|
We'll build a connector reading data from the Exchange Rates API, but the steps will apply to other HTTP APIs you might be interested in integrating with.
|
|
|
|
The API documentations can be found [here](https://exchangeratesapi.io/documentation/).
|
|
In this tutorial, we will read data from the following endpoints:
|
|
|
|
- `Latest Rates Endpoint`
|
|
- `Historical Rates Endpoint`
|
|
|
|
With the end goal of implementing a `Source` with a single `Stream` containing exchange rates going from a base currency to many other currencies.
|
|
The output schema of our stream will look like the following:
|
|
|
|
```json
|
|
{
|
|
"base": "USD",
|
|
"date": "2022-07-15",
|
|
"rates": {
|
|
"CAD": 1.28,
|
|
"EUR": 0.98
|
|
}
|
|
}
|
|
```
|
|
|
|
## Exchange Rates API Setup
|
|
|
|
Before we can get started, you'll need to generate an API access key for the Exchange Rates API.
|
|
This can be done by signing up for the Free tier plan on [Exchange Rates API](https://exchangeratesapi.io/):
|
|
|
|
1. Visit https://exchangeratesapi.io and click "Get free API key" on the top right
|
|
2. You'll be taken to https://apilayer.com -- finish the sign up process, signing up for the free tier
|
|
3. Once you're signed in, visit https://apilayer.com/marketplace/exchangerates_data-api#documentation-tab and click "Live Demo"
|
|
4. Inside that editor, you'll see an API key. This is your API key.
|
|
|
|
## Requirements
|
|
|
|
- An Exchange Rates API key
|
|
- Python >= 3.9
|
|
- Docker must be running
|
|
- NodeJS
|
|
|
|
## Next Steps
|
|
|
|
Next, we'll [create a Source using the connector generator.](1-create-source.md) |