Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(integrations): Readwise APIs #3231

Open
wants to merge 11 commits into
base: master
Choose a base branch
from

Conversation

sarimabbas
Copy link
Contributor

@sarimabbas sarimabbas commented Jan 1, 2025

Added Readwise integration with support for both Readwise API (v2) and Readwise Reader API (v3)

  • API key authentication for both APIs
  • Documentation
  • Provider logo

The Readwise API (v2) enables access to highlights and books data, while the Reader API (v3) allows saving and fetching documents in Readwise Reader.

@sarimabbas sarimabbas changed the title Add integrations with Readwise APIs feat(integrations): Readwise APIs Jan 1, 2025
authorization: Token ${apiKey}
verification:
method: GET
endpoint: https://readwise.io/api/v2/auth
Copy link
Contributor Author

@sarimabbas sarimabbas Jan 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the v3 api still uses the v2/auth for verification, is it ok to have the full url like this? or will it lead to a bug i.e. https://readwise.io/api/v3/https://readwise.io/api/v2/auth ?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good question, we need to check

Copy link
Contributor Author

@sarimabbas sarimabbas Jan 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried running Nango locally (using docker compose up). Readwise works but Readwise Reader does not work

CleanShot 2025-01-11 at 12 52 06@2x

Perhaps someone from the team would be willing to make a change that allows the endpoint to be a full URL or point me to the code, I am happy to take a stab at it

Copy link
Contributor

@nalanj nalanj Jan 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From reading the code I think on the verification block you can set base_url_override and it will use that on verify.

See

const { method, endpoint, base_url_override: baseUrlOverride, headers } = providerVerification;

authorization: Token ${apiKey}
verification:
method: GET
endpoint: https://readwise.io/api/v2/auth
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good question, we need to check

docs-v2/integrations/all/readwise.mdx Outdated Show resolved Hide resolved
@bodinsamuel bodinsamuel requested a review from a team January 6, 2025 09:52
Copy link

gitguardian bot commented Jan 11, 2025

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

Since your pull request originates from a forked repository, GitGuardian is not able to associate the secrets uncovered with secret incidents on your GitGuardian dashboard.
Skipping this check run and merging your pull request will create secret incidents on your GitGuardian dashboard.

🔎 Detected hardcoded secret in your pull request
GitGuardian id GitGuardian status Secret Commit Filename
8205899 Triggered Generic Password c3582ef packages/cli/docker/docker-compose.yaml View secret
🛠 Guidelines to remediate hardcoded secrets
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secret safely. Learn here the best practices.
  3. Revoke and rotate this secret.
  4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants