alex/anki-connect
1
Fork 0
Code Releases 7 Activity

Merge pull request #403 from Julian/auth

Browse Source 
Make it slightly clearer how to enable authentication.
This commit is contained in:
Alexei Yatskov 2023-09-28 20:48:43 -07:00 committed by GitHub
commit 4847fff790
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -156,6 +156,13 @@ const result = await invoke('deckNames', 6);
console.log(`got list of decks: ${result}`); 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? ### 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 The primary goal for Anki-Connect was to support real-time flash card creation from the