doc/api/reference/general.rst

   1 General Information
   2 ===================
   3
   4 The API can be accessed via http and https. https is preferable from a security
   5 / privacy point of view and should be used by all clients. gpodder.net also
   6 seems to be blocked in China via plain http.
   7
   8 All endpoints are offered at https://api.gpodder.net/3/.
   9
  10
  11 * Request and Response Formats: JSON
  12 * JSONP also available
  13 * Date format: ISO 8601 / `RFC 3339 <http://tools.ietf.org/html/rfc3339>`_
  14   ``YYYY-MM-DDTHH:MM:SSZ``
  15
  16 Podcast is identified by its feed URL, episode is identified by its media URL.
  17
  18 TODO: see http://developer.github.com/v3/ for relevant information!
  19
  20 TODO: see `URI Templates <http://tools.ietf.org/html/rfc6570>`_
  21
  22
  23 Status Codes
  24 ------------
  25
  26 The following status codes can be returned for any API request. Most resources
  27 will, however, define additional status codes.
  28
  29 +----------------------------+-----------------------------------------------+
  30 | Status Code                | Interpretation                                |
  31 +============================+===============================================+
  32 | 200 OK                     | All OK                                        |
  33 +----------------------------+-----------------------------------------------+
  34 | 301 Moved Permanently      | The resource has moved permanently to the     |
  35 |                            | location provided in the Location header.     |
  36 |                            | Subsequent requests should use the new        |
  37 |                            | location directly.                            |
  38 +----------------------------+-----------------------------------------------+
  39 | 303 See Other              | the response to the request is found at the   |
  40 |                            | location provided in the Location header. It  |
  41 |                            | should be retrieved using a GET request       |
  42 +----------------------------+-----------------------------------------------+
  43 | 400 Bad Request            | invalid JSON, invalid types                   |
  44 +----------------------------+-----------------------------------------------+
  45 | 503 Service Unavailable    | The service and/or API are under maintenance  |
  46 +----------------------------+-----------------------------------------------+
  47
  48 * Request not allowed (eg quota, authentication, permissions, etc)
  49
  50
  51 Responses
  52 ---------
  53
  54 All responses are valid JSON (unless otherwise stated).
  55
  56
  57 Error messages
  58 --------------
  59
  60 The response could look like ::
  61
  62     { message: "message", errors: [...] }
  63
  64 Errors could look like this ::
  65
  66     {
  67         resource: "",
  68         field: "",
  69         code: ""
  70     }
  71
  72
  73
  74 Redirects
  75 ---------
  76
  77 permanent (301) vs temporary (302, 307) redirects.
  78
  79
  80 Authentication
  81 --------------
  82
  83 See Authentication API
  84
  85
  86
  87 Rate Limiting
  88 -------------
  89
  90 See usage quotas ::
  91
  92     GET /rate_limit
  93
  94     HTTP/1.1 200 OK
  95     Status: 200 OK
  96     X-RateLimit-Limit: 60
  97     X-RateLimit-Remaining: 56
  98
  99 What counts as request? conditional requests?
 100
 101
 102
 103 Conditional Requests
 104 --------------------
 105
 106 Some responses return ``Last-Modified`` and ``ETag`` headers. Clients SHOULD
 107 use the values of these headers to make subsequent requests to those resources
 108 using the ``If-Modified-Since`` and ``If-None-Match`` headers, respectively. If
 109 the resource has not changed, the server will return a ``304 Not Modified``.
 110 Making a conditional request and receiving a 304 response does not count
 111 against the rate limit.
 112
 113
 114 Formats
 115 -------
 116
 117 All data is exchanged as `JSON <http://tools.ietf.org/html/rfc4627>`_. All
 118 resources are represented as JSON objects, and requests are expected as also
 119 expected to contain JSON objects.
 120
 121
 122 JSONP Callbacks
 123 ^^^^^^^^^^^^^^^
 124
 125 You can pass a ``?callback=<function-name>`` parameter to any GET call to have
 126 the results wrapped in a JSON function. This is typically used when browsers
 127 want to embed content received from the API in web pages by getting around
 128 cross domain issues. The response includes the same data output as the regular
 129 API, plus the relevant HTTP Header information.