feedservice/index.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3  <head>
   4   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   5   <title>gpodder.net Feed-Service</title>
   6  </head>
   7
   8  <body>
   9   <h1>gpodder.net Feed-Service</h1>
  10
  11   <p>The gpodder.net Feed-Service is a webservice for parsing podcast feeds and
  12   returning the simplified contents as JSON.</p>
  13
  14   <h2>Usage</h2>
  15   <p>Parameters to /parse (either GET or POST)
  16    <ul>
  17     <li><strong>url</strong>: The URL of the feed that should be parsed (required). This parameter can be repeated multiple times. The values can be URL-encoded.</li>
  18     <li><strong>inline_logo</strong>: If set to 1, the (unscaled) logos are included in the response as <a href="http://en.wikipedia.org/wiki/Data_URI_scheme">data URIs</a> (default 0).</li>
  19     <li><strong>scale_logo</strong>: If inline_logo is set to 1, scales the included logo down to the given size. The resulting image is fitted into a square with the given side-length. If the given size is greater than the original size, the image won't be scaled at all.</li>
  20    </ul>
  21   </p>
  22
  23   <p>Examples:
  24    <pre>
  25     <a href="/parse?url=http://feeds.feedburner.com/linuxoutlaws&inline_logo=1&scale_logo=30">curl http://mygpo-feedservice.appspot.com/parse?<strong>url</strong>=http://feeds.feedburner.com/linuxoutlaws&<strong>inline_logo</strong>=1&<strong>scale_logo</strong>=30</a>
  26     <a href="/parse?url=http://leo.am/podcasts/floss&url=http://feeds.twit.tv/floss_video_large">curl http://mygpo-feedservice.appspot.com/parse?<strong>url</strong>=http://leo.am/podcasts/floss&<strong>url</strong>=http://feeds.twit.tv/floss_video_large</a>
  27     <a href="/parse?url=http://www.dancarlin.com/cswdc.xml">curl http://mygpo-feedservice.appspot.com/parse?<strong>url</strong>=http://www.dancarlin.com/cswdc.xml</a>
  28     curl -d url=http://feeds.feedburner.com/linuxoutlaws http://mygpo-feedservice.appspot.com/parse
  29    </pre>
  30   </p>
  31
  32   <p>If you intend to use <em>this instance</em> of the webservice in your
  33   application, please contact <a
  34   href="mailto:stefan@skoegl.net">stefan@skoegl.net</a> beforehand.
  35
  36   <h2>Source Code</h2>
  37   <p>The sourcecode is available from <a
  38   href="http://repo.or.cz/w/mygpo-feedservice.git">http://repo.or.cz/w/mygpo-feedservice.git</a>
  39   under the terms of the GPLv3.</p>
  40
  41
  42  </body>
  43 </html>