Skip to content
This repository has been archived by the owner on Dec 31, 2023. It is now read-only.

Commit

Permalink
Make it slightly clearer how to enable authentication.
Browse files Browse the repository at this point in the history
The README previously sort of covered this, but in particular it was not
obvious to me that the request parameter that corresponded to enabling
`apiKey` is called `key`, and not `apiKey`, which ultimately made me
have to look at the source code to figure this out (even though the word
`key` is mentioned elsewhere on the page, it still wasn't very easy to
make the connection).

This section puts all the required information in one spot.
  • Loading branch information
Julian committed Sep 24, 2023
1 parent b896b66 commit 82210dd
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,13 @@ const result = await invoke('deckNames', 6);
console.log(`got list of decks: ${result}`);
```
### Authentication
Anki-Connect supports requiring authentication in order to make API requests.
This support is *disabled* by default, but can be enabled by setting the `apiKey` field of Anki-Config's settings (Tools->Add-ons->AnkiConnect->Config) to a desired string.
If you have done so, you should see the [`requestPermission`](#requestpermission) API request return `true` for `requireApiKey`.
You then must include an additional parameter called `key` in any further API request bodies, whose value must match the configured API key.
### Hey, could you add a new action to support $FEATURE?
The primary goal for Anki-Connect was to support real-time flash card creation from the
Expand Down

0 comments on commit 82210dd

Please sign in to comment.