45ad415a83
* Pocket Source Connector initial implementation * Update changelog with PR id * Style fixes & bootstrap.md * Delete abnormal_state.json * Update setup.py * Update invalid_config.json * Delete sample_state.json * Update retrieve.json * Update acceptance.py * Rename Pocket Extractor test * Add `schema_loader` as a workaround to prevent `EmptySchemaLoader` * auto-bump connector version Co-authored-by: Vincent Koc <koconder@users.noreply.github.com> Co-authored-by: Vincent Koc <koconder@gmail.com> Co-authored-by: Vincent Koc <vincentkoc@ieee.org> Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
55 lines
2.3 KiB
Markdown
55 lines
2.3 KiB
Markdown
# Pocket
|
|
|
|
## Overview
|
|
|
|
The Pocket source connector only supports full refresh syncs
|
|
|
|
### Output schema
|
|
|
|
A single output stream is available from this source:
|
|
|
|
* [Retrieve](https://getpocket.com/developer/docs/v3/retrieve)
|
|
|
|
### Features
|
|
|
|
| Feature | Supported? |
|
|
|:------------------|:-----------|
|
|
| Full Refresh Sync | Yes |
|
|
| Incremental Sync | No |
|
|
|
|
### Performance considerations
|
|
|
|
For more info on rate limiting, please refer to [Pocket Docs > Rate Limits](https://getpocket.com/developer/docs/rate-limits)
|
|
|
|
## Getting started
|
|
|
|
### Requirements
|
|
|
|
* Consumer Key
|
|
* Access Token
|
|
|
|
### Setup Guide
|
|
|
|
In order to obtain the Consumer Key and Access Token, please follow the official [Pocket Authentication docs](https://getpocket.com/developer/docs/authentication).
|
|
|
|
It's nevertheless, very recommended to follow [this guide](https://www.jamesfmackenzie.com/getting-started-with-the-pocket-developer-api/) by James Mackenzie, which is summarized below:
|
|
|
|
1. Create an App in the [Pocket Developer Portal](https://getpocket.com/developer/apps/new), give it Retrieve permissions and get your Consumer Key.
|
|
2. Obtain a Request Token. To do so, you need to issue a POST request to get a temporary Request Token. You can execute the command below:
|
|
```sh
|
|
curl --insecure -X POST -H 'Content-Type: application/json' -H 'X-Accept: application/json' \
|
|
https://getpocket.com/v3/oauth/request -d '{"consumer_key":"REPLACE-ME","redirect_uri":"http://www.google.com"}'
|
|
```
|
|
3. Visit the following website from your browser, and authorize the app: `https://getpocket.com/auth/authorize?request_token=REPLACE-ME&redirect_uri=http://www.google.com`
|
|
4. Convert your Request Token Into a Pocket Access Token. To do so, you can execute the following command:
|
|
```sh
|
|
curl --insecure -X POST -H 'Content-Type: application/json' -H 'X-Accept: application/json' \
|
|
https://getpocket.com/v3/oauth/authorize -d '{"consumer_key":"REPLACE-ME","code":"REQUEST-TOKEN"}'
|
|
```
|
|
|
|
## Changelog
|
|
|
|
| Version | Date | Pull Request | Subject |
|
|
|:--------|:-----------|:-----------------------------------------------------------|:------------------------------------------------|
|
|
| 0.1.0 | 2022-10-30 | [18655](https://github.com/airbytehq/airbyte/pull/18655) | 🎉 New Source: Pocket |
|