mirrors/nocobase
1
0
Fork 0
mirror of https://github.com/nocobase/nocobase synced 2024-11-16 02:35:14 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
6cfd586175
nocobase/packages/plugins/api-keys/docs/en-US/usage.md
Dunqing 6cfd586175
feat(plugin-api-keys): support fetch api via api-keys (#2136) 
* feat(plugin-api-keys): support fetch api via api-keys

* feat: full support

* fix: missing parseToken in auth

* feat: add created at column

* feat: configure snippet

* fix: remove unused code

* fix: revert

* chore: update deps

* feat: improve role

* fix: avoid create api key without not exist role

* feat: improve select roles

* refactor: when no X-Role is found, roles should not be randomly assigned

* feat: improve code

* feat: improve current role

* fix: revert

* fix: revert apilicent

* fix: revert auth

* feat: improve currentRole logic

* feat: use resourcer.use instead it

* refactor: remove api-keys-auth

* fix: type

* refactor: move jwt to authManager

* refactor: remove unused code

* refactor: remove protected

* Revert "refactor: remove unused code"

This reverts commit 8f81535ab7.

* feat: remove unused code

* feat: improve code

* fix: test error

* test: update test

* test: add test cases

* docs: update

* chore: update X-Role

* fix: token's roleName not work

* docs: update usage

* fix: i18n Add APi key

* docs: update capital

* docs: update

* feat: clean

* Update package.json

* Update roles.ts

* fix: api key

---------

Co-authored-by: chenos <chenlinxh@gmail.com>
2023-06-30 11:20:35 +08:00

593 B
Raw Blame History

API keys Usage

Creating an API key

After enabling the plugin, go to the API keys plugin management page, click Add API key, fill in the relevant information, and click Save to create an API key.

Using an API key

Add the Authorization field to the request header, with the value of Bearer ${API_KEY}, to access all NocoBase APIs using the API key.

Here's an example using cURL:

curl '{domain}/api/roles:check' -H 'Authorization: Bearer {API key}'

Deleting an API key

Currently, deleting an API key does not make it invalid. Please keep your API key safe.