Revision 79b5d61b docs/astakos-api-guide.rst
| b/docs/astakos-api-guide.rst | ||
|---|---|---|
| 20 | 20 |
========================= ================================ |
| 21 | 21 |
Revision Description |
| 22 | 22 |
========================= ================================ |
| 23 |
0.14 (May 02, 2013) Change URIs (keep also the old ones until the next version) |
|
| 23 | 24 |
0.13 (January 21, 2013) Extend api to export user presentation & quota information. |
| 24 | 25 |
0.6 (June 06, 2012) Split service and admin API. |
| 25 | 26 |
0.1 (Feb 10, 2012) Initial release. |
| ... | ... | |
| 30 | 31 |
|
| 31 | 32 |
Returns a json formatted list containing information about the supported cloud services. |
| 32 | 33 |
|
| 33 |
==================== ========= ================== |
|
| 34 |
Uri Method Description |
|
| 35 |
==================== ========= ================== |
|
| 36 |
``/im/get_services`` GET Get cloud services
|
|
| 37 |
==================== ========= ================== |
|
| 34 |
============================= ========= ==================
|
|
| 35 |
Uri Method Description
|
|
| 36 |
============================= ========= ==================
|
|
| 37 |
``/astakos/api/get_services`` GET Get cloud services
|
|
| 38 |
============================= ========= ==================
|
|
| 38 | 39 |
|
| 39 | 40 |
Example reply: |
| 40 | 41 |
|
| ... | ... | |
| 44 | 45 |
{"url": "/okeanos.html", "name": "~okeanos", "id": "2"},
|
| 45 | 46 |
{"url": "/ui/", "name": "pithos+", "id": "3"}]
|
| 46 | 47 |
|
| 48 |
.. warning:: The service is also available under ``/im/get_services``. |
|
| 49 |
It will be removed in the next version. |
|
| 50 |
|
|
| 47 | 51 |
|
| 48 | 52 |
Get Menu |
| 49 | 53 |
^^^^^^^^ |
| 50 | 54 |
|
| 51 | 55 |
Returns a json formatted list containing the cloud bar links. |
| 52 | 56 |
|
| 53 |
==================== ========= ================== |
|
| 54 |
Uri Method Description |
|
| 55 |
==================== ========= ================== |
|
| 56 |
``/im/get_menu`` GET Get cloud bar menu
|
|
| 57 |
==================== ========= ================== |
|
| 57 |
========================= ========= ==================
|
|
| 58 |
Uri Method Description
|
|
| 59 |
========================= ========= ==================
|
|
| 60 |
``/astakos/api/get_menu`` GET Get cloud bar menu
|
|
| 61 |
========================= ========= ==================
|
|
| 58 | 62 |
|
| 59 | 63 |
Example reply if request user is not authenticated: |
| 60 | 64 |
|
| ... | ... | |
| 66 | 70 |
|
| 67 | 71 |
:: |
| 68 | 72 |
|
| 69 |
[{"url": "/im/login", "name": "user@example.com"},
|
|
| 70 |
{"url": "/im/profile", "name": "My account"},
|
|
| 73 |
[{"url": "/im/", "name": "user@example.com"},
|
|
| 74 |
{"url": "/im/landing", "name": "Dashboard"},
|
|
| 71 | 75 |
{"url": "/im/logout", "name": "Sign out"}]
|
| 72 | 76 |
|
| 77 |
.. warning:: The service is also available under ``/im/get_menu``. |
|
| 78 |
It will be removed in the next version. |
|
| 79 |
|
|
| 73 | 80 |
Admin API Operations |
| 74 | 81 |
-------------------- |
| 75 | 82 |
|
| ... | ... | |
| 84 | 91 |
|
| 85 | 92 |
Authenticate API requests require a token. An application that wishes to connect to Astakos, but does not have a token, should redirect the user to ``/login``. (see :ref:`authentication-label`) |
| 86 | 93 |
|
| 87 |
==================== ========= ================== |
|
| 88 |
Uri Method Description |
|
| 89 |
==================== ========= ================== |
|
| 90 |
``/im/authenticate`` GET Authenticate user using token
|
|
| 91 |
==================== ========= ================== |
|
| 94 |
============================= ========= ==================
|
|
| 95 |
Uri Method Description
|
|
| 96 |
============================= ========= ==================
|
|
| 97 |
``/astakos/api/authenticate`` GET Authenticate user using token
|
|
| 98 |
============================= ========= ==================
|
|
| 92 | 99 |
|
| 93 | 100 |
| |
| 94 | 101 |
|
| ... | ... | |
| 225 | 232 |
500 (Internal Server Error) The request cannot be completed because of an internal error |
| 226 | 233 |
=========================== ===================== |
| 227 | 234 |
|
| 235 |
.. warning:: The service is also available under ``/im/authenticate``. |
|
| 236 |
It will be removed in the next version. |
|
| 237 |
|
|
| 228 | 238 |
|
| 229 | 239 |
Send feedback |
| 230 | 240 |
^^^^^^^^^^^^^ |
| ... | ... | |
| 234 | 244 |
========================= ========= ================== |
| 235 | 245 |
Uri Method Description |
| 236 | 246 |
========================= ========= ================== |
| 237 |
``/feedback`` POST Send feedback
|
|
| 247 |
``astakos/api/feedback`` POST Send feedback
|
|
| 238 | 248 |
========================= ========= ================== |
| 239 | 249 |
|
| 240 | 250 |
| |
| ... | ... | |
| 274 | 284 |
================================ ========= ================== |
| 275 | 285 |
Uri Method Description |
| 276 | 286 |
================================ ========= ================== |
| 277 |
``/user_catalogs`` POST Get 2 catalogs containing uuid to displayname mapping and the opposite
|
|
| 287 |
``astakos/api/user_catalogs`` POST Get 2 catalogs containing uuid to displayname mapping and the opposite
|
|
| 278 | 288 |
================================ ========= ================== |
| 279 | 289 |
|
| 280 | 290 |
| |
| ... | ... | |
| 329 | 339 |
|
| 330 | 340 |
Return a json formatted dictionary containing information about a specific user |
| 331 | 341 |
|
| 332 |
================================ ========= ================== |
|
| 333 |
Uri Method Description |
|
| 334 |
================================ ========= ================== |
|
| 335 |
``/user_catalogs`` POST Get 2 catalogs containing uuid to displayname mapping and the opposite
|
|
| 336 |
================================ ========= ================== |
|
| 342 |
===================================== ========= ==================
|
|
| 343 |
Uri Method Description
|
|
| 344 |
===================================== ========= ==================
|
|
| 345 |
``astakos/api/service/user_catalogs`` POST Get 2 catalogs containing uuid to displayname mapping and the opposite
|
|
| 346 |
===================================== ========= ==================
|
|
| 337 | 347 |
|
| 338 | 348 |
| |
| 339 | 349 |
|
Also available in: Unified diff