mirror of
https://github.com/zulip/zulip.git
synced 2025-11-04 05:53:43 +00:00
dfb9f74017
Adds a page to the general api documentation about HTTP headers, so that information about the special response headers for rate limits have a more logical location in the docs and so that other HTTP header information can be shared, such as `User-Agent` conventions. Adjusts some text and linking on the rest-error-handling page and overview page for the REST API for the addition of the HTTP headers page.
33 lines
1.4 KiB
Markdown
33 lines
1.4 KiB
Markdown
# The Zulip REST API
|
|
|
|
The Zulip REST API powers the Zulip web and mobile apps, so anything
|
|
you can do in Zulip, you can do with Zulip's REST API. To use this API:
|
|
|
|
* You'll need to [get an API key](/api/api-keys). You will likely
|
|
want to [create a bot](/help/add-a-bot-or-integration), unless you're
|
|
using the API to interact with
|
|
your own account (e.g. exporting your personal message history).
|
|
* Choose what language you'd like to use. You can download the
|
|
[Python or JavaScript bindings](/api/installation-instructions), projects in
|
|
[other languages](/api/client-libraries), or
|
|
just make HTTP requests with your favorite programming language.
|
|
* If you're making your own HTTP requests, you'll want to send the
|
|
appropriate [HTTP basic authentication headers](/api/http-headers).
|
|
* The Zulip API has a standard
|
|
[system for reporting errors](/api/rest-error-handling).
|
|
|
|
Most other details are covered in the documentation for the individual
|
|
endpoints:
|
|
|
|
!!! tip ""
|
|
|
|
You may use the `client.call_endpoint` method of our Python API
|
|
bindings to call an endpoint that isn't documented here. For an
|
|
example, see [Upload a custom emoji](/api/upload-custom-emoji).
|
|
|
|
{!rest-endpoints.md!}
|
|
|
|
Since Zulip is open source, you can also consult the
|
|
[Zulip server source code](https://github.com/zulip/zulip/) as a
|
|
workaround for how to do anything not documented here.
|