doc/api/reference/user.rst

   1 User API
   2 ========
   3
   4 The User API can be used to retrieve public information about a user, and to
   5 discover user-related resources.
   6
   7 When initiating a session, a client SHOULD query the user information, to
   8 discover URIs for further queries.
   9
  10
  11 Resources
  12 ---------
  13
  14 The User API defines the following resources ::
  15
  16   /user/{username}
  17
  18
  19 Get User Info
  20 -------------
  21
  22 Request ::
  23
  24     GET /user/{username}
  25     Content-Tpe: application/json
  26
  27
  28 Response::
  29
  30     200 Found
  31     Content-Tpe: application/json
  32
  33     {
  34         "username": "stefan",
  35         "avatar": "http://....",
  36         "twitter": "@skoegl",
  37         "description": "hi...",
  38         "flattr_username": "stefankoegl",
  39
  40         "resources": {
  41             "subscriptions": "http://api.gpodder.net/3/user/{username}/subscriptions",
  42             ...
  43         }
  44     }
  45