wineryan (wineryan) wrote,

FeedFlare Developer Guide Introduction

FeedFlare Developer Guide
The FeedFlare API (FlareAPI) allows anyone to extend our existing FeedFlare service. Provide new actions and incorporate outside services to make your content more interesting and engaging — both in your FeedBurner feed and on your website.
This document assumes you are a web application developer familiar with XML and one or more server-side programming structures, such as Perl, Cold Fusion, Java/JSP, ASP, or Ruby. Server-side language skills are required in order to create "dynamic" FeedFlare units, which are described in more detail below.
Note: In the XML code samples below, the ↵ symbol is used to indicate a linebreak used for spacing in the middle of long, unbroken string (such as a URL). If you copy and paste the code, you will want to remove this character and stitch the string back together at the point this symbol appeared.
FeedFlare Units
The code that defines how FeedFlare should operate is encapsulated in a FeedFlare Unit file. This is an XML document that tells FeedBurner how to render a FeedFlare in the feed and on the site, and it identifies the communication channels that need to be established when creating an instance of a FeedFlare. Every FeedFlare unit is ultimately identified by a URL that either FeedBurner or a third party maintains.
A FeedFlare unit has two pieces of information: catalog information and the instructions for generating an instance of a FeedFlare. Additional attributes and behaviors will be added over time. There are two main classifications for a FeedFlare unit: static or dynamic. A static FeedFlare unit (represented by a element in the unit XML) generates FeedFlare that does not change its text or image over time, while a dynamic FeedFlare unit (represented by a element in the unit XML) might change its representation based upon the item data over time. A FeedFlare that says "Email This" would most likely be static, while a FeedFlare that says "There are 3 comments ... add yours now!" would be dynamic (because the number of comments would most likely increase over time). In both cases, the flare link destination will likely be variable based upon information from the feed or item.
FeedFlare Unit Examples
Example 1: Hello, World
Ah, Hello World, my old friend. We meet again. Let's say that we want to create a FeedFlare unit that just says "Hello, World" and nothing else. It's so featureless it doesn't even offer a link to click on, but we have to start somewhere.
Here's what this FeedFlare unit looks like:
   <Title>Hello World 1</Title>

       <Description>A static FeedFlare unit that just shows the text "Hello, World"
  <Text>Hello, World</Text>


To create this FeedFlare unit, we have to create an XML file and then host it somewhere so it has a URL FeedBurner can read.
Aside: Where do I put this XML file?
more -
Tags: web & tools, webmaster
  • Post a new comment


    Anonymous comments are disabled in this journal

    default userpic

    Your reply will be screened

    Your IP address will be recorded