77c7d3e9b3
* Adding transactions for klarna source integration * Fixing tests * Adding payout stream * Finalizing connector * Adding new lines af EOF * Applying code review suggestions. Adding doc for klarna. Adding title in spec.yaml * run format * format files * add to source def * auto-bump connector version Co-authored-by: marcosmarxm <marcosmarxm@gmail.com> Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
62 lines
2.6 KiB
Markdown
62 lines
2.6 KiB
Markdown
# Klarna
|
|
|
|
This page contains the setup guide and reference information for the Klarna source connector.
|
|
|
|
## Prerequisites
|
|
|
|
The [Klarna Settlements API](https://developers.klarna.com/api/#settlements-api) is used to get the payouts and transactions for a Klarna account.
|
|
|
|
## Setup guide
|
|
### Step 1: Set up Klarna
|
|
|
|
In order to get an `Username (UID)` and `Password` please go to [this](https://docs.klarna.com/) page here you should find **Merchant Portal** button. Using this button you could log in to your production / playground in proper region. After registration / login you may find and create `Username (UID)` and `Password` in settings tab.
|
|
|
|
:::note
|
|
|
|
Klarna Source Connector does not support OAuth at this time due to limitations outside of control.
|
|
|
|
:::
|
|
|
|
## Step 2: Set up the Klarna connector in Airbyte
|
|
|
|
### For Airbyte Open Source:
|
|
1. Navigate to the Airbyte Open Source dashboard
|
|
2. Set the name for your source
|
|
3. Choose if your account is sandbox
|
|
4. Enter your username
|
|
5. Enter your password
|
|
6. Enter the date you want your sync to start from
|
|
7. Click **Set up source**
|
|
|
|
## Supported sync modes
|
|
|
|
The Klarna source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes):
|
|
|
|
| Feature | Supported? |
|
|
| :------------------------ |:-----------|
|
|
| Full Refresh Sync | Yes |
|
|
| Incremental - Append Sync | No |
|
|
|
|
|
|
## Supported Streams
|
|
|
|
This Source is capable of syncing the following Klarna Settlements Streams:
|
|
|
|
* [Payouts](https://developers.klarna.com/api/#settlements-api-get-all-payouts)
|
|
* [Transactions](https://developers.klarna.com/api/#settlements-api-get-transactions)
|
|
|
|
## Performance considerations
|
|
|
|
Klarna API has [rate limiting](https://developers.klarna.com/api/#api-rate-limiting)
|
|
|
|
**Production environments**: the API rate limit is 20 create-sessions per second on average measured over a 1-minute period. For the other operations, the API limit is 200 requests per second on average, measured over a 1 minute period
|
|
**Playground environments**: the API rate limit is one quarter (1/4th) of the rate limits of production environments.
|
|
|
|
Connector will handle an issue with rate limiting as Klarna returns 429 status code when limits are reached
|
|
|
|
## Changelog
|
|
|
|
| Version | Date | Pull Request | Subject |
|
|
|:--------|:-----------|:---------------------------------------------------------|:-----------------------------------------------|
|
|
| 0.1.0 | 2022-10-24 | [18385](https://github.com/airbytehq/airbyte/pull/18385) | Klarna Settlements Payout and Transactions API |
|