Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/templates/zerver/api/api-keys.md

29 lines
1.0 KiB
Markdown
Raw Normal View History

/api/: Add Markdown-based /api-new documentation. This commit allows for the /api-new/ page to rendered similarly to our /help pages. It's based on the old content for /api, but we're not replacing the old content yet, to give a bit of time to restructure things reasonably. Tweaked by eeshangarg and tabbott.
2017-07-25 02:37:04 +02:00
# API keys
You can create bots on your [settings page](/#settings).
docs: Update API key-related screenshots.
2018-05-05 21:59:01 +02:00
Once you have a bot, you can use its email and API key to send messages.
/api/: Add Markdown-based /api-new documentation. This commit allows for the /api-new/ page to rendered similarly to our /help pages. It's based on the old content for /api, but we're not replacing the old content yet, to give a bit of time to restructure things reasonably. Tweaked by eeshangarg and tabbott.
2017-07-25 02:37:04 +02:00
Create a bot:
docs: Update API key-related screenshots.
2018-05-05 21:59:01 +02:00
/api/: Add Markdown-based /api-new documentation. This commit allows for the /api-new/ page to rendered similarly to our /help pages. It's based on the old content for /api, but we're not replacing the old content yet, to give a bit of time to restructure things reasonably. Tweaked by eeshangarg and tabbott.
2017-07-25 02:37:04 +02:00
<img class="screenshot" src="/static/images/api/create-bot.png" />
Look for the bot's email and API key:
docs: Update API key-related screenshots.
2018-05-05 21:59:01 +02:00
/api/: Add Markdown-based /api-new documentation. This commit allows for the /api-new/ page to rendered similarly to our /help pages. It's based on the old content for /api, but we're not replacing the old content yet, to give a bit of time to restructure things reasonably. Tweaked by eeshangarg and tabbott.
2017-07-25 02:37:04 +02:00
<img class="screenshot" src="/static/images/api/bot-key.png" />
docs: Update API key-related screenshots.
2018-05-05 21:59:01 +02:00
If you prefer to send messages as your own user, you can also find your API key on your [settings page](/#settings):
<img class="screenshot" src="/static/images/api/user-api-key.png" />
When using our Python bindings, you may either specify the user
/api/: Add Markdown-based /api-new documentation. This commit allows for the /api-new/ page to rendered similarly to our /help pages. It's based on the old content for /api, but we're not replacing the old content yet, to give a bit of time to restructure things reasonably. Tweaked by eeshangarg and tabbott.
2017-07-25 02:37:04 +02:00
and API key for each Client object that you initialize, or let the binding look for
docs: Update API key-related screenshots.
2018-05-05 21:59:01 +02:00
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" />
docs: Explain how to configure the Python bindings. The Python bindings (which are used for bots, amongst other things) can be configured either with a .zuliprc file or with environment variables in the host machine. This new page in the user docs explains how to set the bindings up using both techniques, and is a good reference on the setup required by Zulip bots.
2018-05-13 21:02:41 +02:00
Another alternative is manually creating your own `.zuliprc` file, or setting
environment variables that are equivalent. You can find out more about these
methods [here](/api/configuring-python-bindings).
docs: Update API key-related screenshots.
2018-05-05 21:59:01 +02:00