Mercurial > kallithea

comparison docs/api/api.rst @ 1915:54e84659cb3a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fixes for release 1.2.4 - docs updates - requires.txt file - changelog
author Marcin Kuzminski <marcin@python-works.com>
date Thu, 19 Jan 2012 06:46:25 +0200
parents 466292e57bfd
children 82a88013a3fd
comparison
equal deleted inserted replaced
1910:466292e57bfd 1915:54e84659cb3a
8 Starting from RhodeCode version 1.2 a simple API was implemented. 8 Starting from RhodeCode version 1.2 a simple API was implemented.
9 There's a single schema for calling all api methods. API is implemented 9 There's a single schema for calling all api methods. API is implemented
10 with JSON protocol both ways. An url to send API request in RhodeCode is 10 with JSON protocol both ways. An url to send API request in RhodeCode is
11 <your_server>/_admin/api 11 <your_server>/_admin/api
12 12
13 API ACCESS FOR WEB VIEWS
14 ++++++++++++++++++++++++
15
16 API access can also be turned on for each web view in RhodeCode that is
17 decorated with `@LoginRequired` decorator. To enable API access simple change
18 the standard login decorator to `@LoginRequired(api_access=True)`.
19 After this change, a rhodecode view can be accessed without login by adding a
20 GET parameter `?api_key=<api_key>` to url. By default this is only
21 enabled on RSS/ATOM feed views.
22
23
24 API ACCESS
25 ++++++++++
13 26
14 All clients are required to send JSON-RPC spec JSON data:: 27 All clients are required to send JSON-RPC spec JSON data::
15 28
16 { 29 {
17 "api_key":"<api_key>", 30 "api_key":"<api_key>",