Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Update API key-related screenshots.

This commit is contained in:
Yago González 2018-05-05 21:59:01 +02:00 committed by Tim Abbott
parent 5c0d4660c1
commit 7ae51a4ec6
5 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
static/images/api/bot-key.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 40 KiB

BIN
static/images/api/create-bot.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 37 KiB

BIN
static/images/api/download-zuliprc.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 12 KiB

BIN
static/images/api/user-api-key.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 102 KiB

19
templates/zerver/api/api-keys.md
View File

@ -1,18 +1,28 @@
# API keys # API keys
You can create bots on your [settings page](/#settings). You can create bots on your [settings page](/#settings).
Once you have a bot, you can use its email and API key to send messages.</p> Once you have a bot, you can use its email and API key to send messages.
Create a bot: Create a bot:
<img class="screenshot" src="/static/images/api/create-bot.png" /> <img class="screenshot" src="/static/images/api/create-bot.png" />
Look for the bot's email and API key: Look for the bot's email and API key:
<img class="screenshot" src="/static/images/api/bot-key.png" /> <img class="screenshot" src="/static/images/api/bot-key.png" />
If you prefer to send messages as your own user, you can also find your API key on your [settings page](/#settings). If you prefer to send messages as your own user, you can also find your API key on your [settings page](/#settings):
When using our python bindings, you may either specify the user
<img class="screenshot" src="/static/images/api/user-api-key.png" />
When using our Python bindings, you may either specify the user
and API key for each Client object that you initialize, or let the binding look for and API key for each Client object that you initialize, or let the binding look for
them in your `~/.zuliprc`, the default config file, which you can create as follows: them in your `~/.zuliprc`. An automatically generated default version can be found in
your bot's details:
<img class="screenshot" src="/static/images/api/download-zuliprc.png" />
Or you may also create it manually, as follows:
``` ```
[api] [api]
@ -42,3 +52,4 @@ The following variables can be specified:
5. `ZULIP_CERT` 5. `ZULIP_CERT`
6. `ZULIP_CERT_KEY` 6. `ZULIP_CERT_KEY`
7. `ZULIP_CERT_BUNDLE` 7. `ZULIP_CERT_BUNDLE`