Personal tools

API

From ScotEduBlogs Wiki

Jump to: navigation, search

This is a spec for a proposed ScotEduBlogs API, this will hopefully be of use to bloggers and others interested in mashing up data. Some of the proposed data, eg geo location is not held in the SEB database yet. If you are interested in using an api feel free to edit this page.

Contents

Proposed Methods

getBlogList

getBlogList returns a list of blogs with url rss url and optionally tags, la & geo (perhaps other stuff)

eg: scotedublogs.org.uk/api/getBlogList?tags=primary,teacher&tagmode=all&extras=tags,geo

This would return some xml:
<rsp stat="ok">
 <blogs>
	<blog id="1416506385" xmlUrl="http://feeds.feedburner.com/johnjohnston/" htmlUrl="http://www.sandaigprimary.co.uk/pivot/johnjohnston.php" />
	<title>John @ Sandaig</title>
	<description> mostly what we are doing with ict in class and some links</description>
	<tags>
		<tag>blogging</tag>
		<tag>classroom</tag>
		<tag>podcasting</tag>
		<tag>primary</tag>
		<tag>teacher</tag>
	</tags>
	<geo>
		<geo:lat>55.87822384088213</geo:lat>
		<geo:long>-4.322605133056641</geo:long>
	</geo>
</blog>

....more of the same

</blogs>
<rsp>

blogGetPosts

returns a list of recent posts to a particular blog (or tag ?) eg:

 scotedublogs.org.uk/api/getposts?blog_id=123344656
<rsp stat="ok">
	<posts>
		<post datetaken="2007-09-21 11:51:01" title="As Daft As It Sounds?" url="http://edubuzz.org/blogs/alancoady/2007/09/24/as-daft-as-it-sounds/" />
		
		<post	more of the same		/>
		<post	more of the same		/>
		<post	more of the same		/>
		<post	more of the same		/>
		 
	<posts>
</rsp>
 

getStats

scotedublogs.org.uk/api/getStats?params params could be blog_id, tag, la , linit=number_of_days

need to figure out what to return

Possible uses

mashups

If data held on site included geo tags it would be easy to produce maps of blogs or blogs tagged etc with google maps.

data collection

collect blogs with api and pass to technorati for stats on popularity etc