Introduction to the Userfeeds Platform¶
Userfeeds is envisioned as an infrastructure platform which allows developers to utilize easily content rankings for their own use or for their clients and build better ones whenever needed.
The product and core of the Userfeeds Platform which can be used for that purpose is the http API which allows to get data from internet transactions as well as content rankings and to access databases in which data on transactions, which make the rankings, are stored.
Rankings for transactions can be obtained through the utilization of algorithms which are actually pre-defined queries designed for searching through Ethereum. Those queries can also be seen as a set of tools supporting the interface. Examples of content rankings are: a list of products on amazon.com, songs in a playlist on spotify, news on NYTimes, and all other places which have some content (links, articles, songs) sorted in a particular way which you can access.
It is also possible to track financial information (records) regarding particular users and transactions via smart contracts which are a sort of token defined for information storing.
In order to make full use of the API and all algorithms it is essential that you have a wallet and an account for the Etherum crypto-currency created. Currently Ethereum, Bitcoin and IPDB are supported on the platform.
For easy set-up of both the wallet and the account, the MetaMask service can be used available at https://metamask.io/.
For more information on crypto-currencies, visit topic-related websites.
In order to become familiar technically with the Userfeeds Platform and be able to use it efficiently, go to Quick Start - Guide for Developers and API Reference to see how to use our ‘read-only’ APIs and how to use the Ethereum blockchain for pushing information into the Userfeeds Platform. Later on you can go to http://api.userfeeds.io/portal/, and register as a developer, and go to http://api.userfeeds.io/portal/apis/ API Catalog to request for an API Key. When the API Key is ready for you - start using all of our HTTP API’s.
Our mission - as owners of the Userfeeds Platform - is to help developers in obtaining information on rankings and reliable scores (per needed perspective) as well as earning money for promotional actions on web sites by providing them with ‘ready-to-use’ API’s, libraries and algorithms which they can incorporate in an easy way into their software and web pages.
How does the Userfeeds Platform work?¶
The Userfeeds Platform is composed of a couple of parts which interact together in order to deliver rankings through HTTP API’s to your application.
It is important to remember that any internet transaction is a claim. Such Claim is a basic information package signed cryptographically (with use of unique key) and connected with an account - in the json format - key - claim / key - target.
The structure of a claim can be presented in the following way:
from who ; for whom ; how much / amount ; transaction identifier.
The claim can also be understood as metadata for any transaction.
Claims created with help of our algorithms land on the Ethereum blockchain from where they are collected and read. Claims can have extensions which make them a particular type.
First it is the Userfeeds Platform which reads all the information from supported blockchains and stores it in an internal database. We store all transactions and contract calls in the Graph database and current balances in the standard SQL database. When someone sends Claim data to the Userfeeds Platform through the HTTP or through the Ethereum network, it is processed and inserted into the Graph database for further use in ranking algorithms. When an application makes a HTTP request to our Ranking API endpoint, a Ranking Engine takes the requested algorithm and applies it to the current data stored in the Graph database and the SQL database and returns sorted entries for application to display to the user.
Why use the Userfeeds Platform?¶
- All our algorithms are of Open Source type and therefore can be improved any time when an issue arises or changed per current needs
- Everyone is able to create their own custom rankings
- We use the blockchain as the source of ranking signals, for example - how many tokens are connected to given content(s), how stable were token holders endorsing given content(s), how involved they are in given token(s).
- Everyone can monetize their application / site easily by providing sponsored ranking on their application / site
- Everyone can deliver superior experience for their users and visitors by customizing our ranking output basing on your needs
- Introduction of promotional elements and activities to any web service is very easy with our algorithms for web components
- Everyone can make their blogs more engaging by bringing widgets for promoting