zulip/templates/zerver/api/api-keys.md

35 lines
925 B
Markdown
Raw Normal View History

# API keys
2018-09-26 06:02:58 +02:00
An **API key** is how a bot identifies itself to Zulip. Anyone with a
bot's API key can impersonate the bot, so be careful with it!
2018-09-26 06:02:58 +02:00
## Get a bot's API key
2018-09-26 06:02:58 +02:00
{settings_tab|your-bots}
2018-09-26 06:02:58 +02:00
1. Click **Active bots**.
2018-09-26 06:02:58 +02:00
1. Find your bot. The bot's API key is under **API KEY**.
2018-09-26 06:02:58 +02:00
## Get your API key
2018-09-26 06:02:58 +02:00
Anyone with your API key can impersonate you, so be doubly careful with it.
2018-09-26 06:02:58 +02:00
{settings_tab|your-account}
2018-09-26 06:02:58 +02:00
1. Under **API key**, click **Show/change your API key**.
2018-09-26 06:02:58 +02:00
1. Enter your password, and click **Get API key**. If you never had a
password, click **Never had one? Forgotten it?** and follow the
instructions from there.
2018-09-26 06:02:58 +02:00
1. Copy your API key.
## Invalidate an API key
To invalidate a key, follow the instructions above, and click
**Generate new API key** or click the **refresh**
(<i class="fa fa-refresh"></i>) icon as appropriate.
This will generate a new key for you or the bot, and invalidate the old one.