tachybase_todo/packages/plugins/@tachybase/plugin-api-keys/docs/en-US/usage.md

# 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 `TachyBase` APIs using the API key.

Here's an example using cURL:

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

> Warning: When using the `Docker` image to use `TachyBase`, make sure you have configured the [APP_KEY](https://docs.tachybase.com/api/env#app_key) environment variable, otherwise the API key will be invalid after each restart.

## Deleting an API key

After deleting the API key, it will no longer be usable.