Skip to content
This repository has been archived by the owner on Jul 6, 2020. It is now read-only.

How to write an explore service

Bernhard Posselt edited this page Jan 23, 2016 · 13 revisions

This API requires version 7.1.0

If you are using the News app in your company/community it might be interesting to offer your users a bunch of easily to discover default feeds. You could also create a website where people can add and upvote news feeds like bigger cloud feed readers like Feedly do it or even convert their APIs into a service for the News app (if someone wants to provide one for the News app, feel free to contact us by creating an issue in the bug tracker).

The URL should be a path to a directory which contains a JSON file in the format of feeds.LANG_CODE.json where LANG_CODE is a two character language code (e.g. en or de).

For example entering the URL https://domain.com/directory as explore URL will produce the following request for German users:

GET https://domain.com/directory/feeds.de.json

The JSON file itself looks like this:

{
 "Tech": [  // category
  {
   "title": "ownCloud Planet",
   "url": "http://owncloud.org/news/",  // link to the page so the user can view it
   "feed": "http://owncloud.org/feed/",  // link to the exact feed location so we can test if the user uses it already
   "description": "ownCloud Planet is a feed aggregator",
   "votes": 3121,  // the higher the vote count, the further up the entry will appear
   "favicon": "http://owncloud.org/wp-content/themes/owncloudorgnew/assets/img/common/favicon.png",  // optional
   "image": "http://tuxanddroid.de/wp-content/uploads/2013/08/owncloud_logo.png",  // optional
  }, // etc
 ]
}

Do not forget to implement CORS in your API, otherwise the request will fail!

Clone this wiki locally