Skip to content
This repository was archived by the owner on Nov 4, 2025. It is now read-only.

Commit 4847fff

Browse files
authored
Merge pull request #403 from Julian/auth
Make it slightly clearer how to enable authentication.
2 parents b896b66 + 82210dd commit 4847fff

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,13 @@ const result = await invoke('deckNames', 6);
156156
console.log(`got list of decks: ${result}`);
157157
```
158158
159+
### Authentication
160+
161+
Anki-Connect supports requiring authentication in order to make API requests.
162+
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.
163+
If you have done so, you should see the [`requestPermission`](#requestpermission) API request return `true` for `requireApiKey`.
164+
You then must include an additional parameter called `key` in any further API request bodies, whose value must match the configured API key.
165+
159166
### Hey, could you add a new action to support $FEATURE?
160167
161168
The primary goal for Anki-Connect was to support real-time flash card creation from the

0 commit comments

Comments
 (0)