doc/api/reference/index.rst

   1 .. _api-reference:
   2
   3 API Reference
   4 =============
   5
   6 This is the reference documentation for the gpodder.net API 3.
   7
   8 The API can be accessed via http and https. https is preferable from a security
   9 / privacy point of view and should be used by all clients. gpodder.net also
  10 seems to be blocked in China via plain http.
  11
  12 All endpoints are offered at https://api.gpodder.net/3/.
  13
  14 The :ref:`integration-guide` contains additional non-normative information for
  15 integrating gpodder.net into podcasting applications.
  16
  17
  18 **Contents**
  19
  20 .. toctree::
  21    :maxdepth: 2
  22
  23    general
  24    registration
  25    auth
  26    user
  27    directory
  28    devices
  29    subscriptions
  30    events
  31    podcastlists
  32    settings
  33    prepare