Fetch a development API key
For easy testing of mobile apps and other clients and against Zulip
development servers, we support fetching a Zulip API key for any user
on the development server without authentication (so that they can
implement analogues of the one-click login process available for Zulip
development servers on the web).
Note: This endpoint is only available on Zulip development
servers; for obvious security reasons it will always return an error
in a Zulip production server.
POST https://chat.virginvoyages.com/api/v1/dev_fetch_api_key
Usage examples
curl -X POST https://chat.virginvoyages.com/api/v1/dev_fetch_api_key \
-u BOT_EMAIL_ADDRESS:BOT_API_KEY \
-d "username=iago@zulip.com"
Arguments
| Argument |
Example |
Required |
Description |
username |
"iago@zulip.com" |
Yes |
The email address for the user that owns the API key. |
Response
Return values
api_key: The API key that can be used to authenticate as the requested
user.email: The email address of the user who owns the API key.
Example response
A typical successful JSON response may look like:
{
"api_key": "gjA04ZYcqXKalvYMA8OeXSfzUOLrtbZv",
"email": "iago@zulip.com",
"msg": "",
"result": "success"
}