Rest api » History » Version 22

Jean-Philippe Lang, 2010-12-11 14:36
Removed unplanned resources for clarity

1 1 Jean-Philippe Lang
h1. Redmine API
2 1 Jean-Philippe Lang
3 1 Jean-Philippe Lang
Redmine exposes some of its data through a REST API. This API provides access and basic CRUD operations (create, update, delete) for the resources described below.
4 1 Jean-Philippe Lang
5 21 Jean-Philippe Lang
h2. Authentication
6 21 Jean-Philippe Lang
7 21 Jean-Philippe Lang
Most of the time, the API requires authentication. To enable the API-style authentication, you have to check *Enable REST API* in Administration -> Settings -> Authentication. Then, authentication can be done in 2 different ways:
8 21 Jean-Philippe Lang
* using your regular login/password via HTTP Basic authentication.
9 21 Jean-Philippe Lang
* using your API key which is a handy way to avoid putting a password in a script. The API key may be attached to each request as a "key" parameter or it may be passed in as a username with a random password. You can find your API key on your account page ( /my/account ) when logged in, on the right-hand pane of the default layout.
10 21 Jean-Philippe Lang
11 1 Jean-Philippe Lang
12 1 Jean-Philippe Lang
h2. API Description
13 1 Jean-Philippe Lang
14 15 Eric Davis
Status legend:
15 15 Eric Davis
16 15 Eric Davis
* Stable - feature complete, no major changes planned
17 15 Eric Davis
* Beta - usable for integrations with some bugs or missing minor functionality
18 15 Eric Davis
* Alpha - major functionality in place, needs feedback from API users and integrators
19 15 Eric Davis
* Prototype - very rough implementation, possible major breaking changes mid-version. *Not recommended for integration*
20 1 Jean-Philippe Lang
* Planned - planned in a future version, depending on developer availability
21 1 Jean-Philippe Lang
22 1 Jean-Philippe Lang
23 20 Jean-Philippe Lang
|_.Resource                     |_.Status     |_.Notes  |_.Availability|
24 20 Jean-Philippe Lang
|[[Rest_Issues|Issues]]         | Beta        | Usable with some bugs and rough edges.  | 1.0 |
25 20 Jean-Philippe Lang
|[[Rest_Projects|Projects]]     | Beta        | Usable with some bugs and rough edges.  | 1.0 |
26 20 Jean-Philippe Lang
|[[Rest_Users|Users]]           | Planned | | 1.1 |
27 1 Jean-Philippe Lang
|[[Rest_TimeEntries|TimeEntries]]           | Planned | | 1.1 |
28 22 Jean-Philippe Lang
|[[Rest_News|News]]             | Prototype, Planned | Prototype implementation for @index@ only | 1.1 |
29 22 Jean-Philippe Lang
|[[Rest_WikiPages|Wiki Pages]]  | Planned | | 1.2 |
30 1 Jean-Philippe Lang
31 20 Jean-Philippe Lang
h2. API Usage in various languages
32 1 Jean-Philippe Lang
33 5 Jean-Philippe Lang
* [[Rest_api_with_ruby|Ruby]]
34 1 Jean-Philippe Lang
* [[Rest_api_with_php|PHP]]
35 18 Javier Hernandez
* [[Rest_api_with_python|Python]]