This is the code repository for the Revenue Settlement and Sharing System, a Java implementation developed as a part of FIWARE, and the reference implementation of the Revenue Settlement and Sharing System GE.
You find all the information related to the RSS in its page in the FIWARE Catalogue
Any feedback is highly welcome, including bugs, typos or things you think should be included but aren't. You can use GitHub Issues to provide feedback.
You can find the User & Programmer's Manual and the Administration Guide on readthedocs.org
The Revenue Settlement and Sharing System (RSS) GE is in charge of distributing the revenues originated by the usage of a given service among the involved stakeholders. In particular, it focuses on distributing part of the revenue generated by a service between the Store Provider and the Service Provider(s) responsible for the service. With the term "service" we refer to both final applications and backend application services (typically exposed through an API). Note that, in the case of composite services, more than one service provider may have to receive a share of the revenues.
The instructions to install the RSS can be found at the Installation Guide. You can install the software in three different ways:
install.sh
)The main resources available throught the RSS API are:
/fiware-rss/rss/aggregators
/fiware-rss/rss/providers
/fiware-rss/rss/models
/fiware-rss/rss/cdrs
/fiware-rss/rss/reports
With these resources you can:
Use POST
to create entities:
POST
to /fiware-rss/rss/aggregators
POST
to /fiware-rss/rss/provider
POST
to /fiware-rss/rss/models
POST
to /fiware-rss/rss/cdrs
Use GET
to retrive entities:
GET
to /fiware-rss/rss/aggregators
GET
to /fiware-rss/rss/provider
GET
to /fiware-rss/rss/models
GET
to /fiware-rss/rss/cdrs
GET
to /fiware-rss/rss/reports
Additionally, the RSS exposes some resources for expenditure limits management:
expenditureLimit/limits/AGGREGATOR/
expenditureLimit/balance/USER
With these resources you can:
Use POST to create entities:
POST
to expenditureLimit/limits/AGGREGATOR/PROVIDER
POST
to expenditureLimit/limits/AGGREGATOR/PROVIDER/USER
POST
to expenditureLimit/balance/USER
Use POST
to partialy update entities:
POST
to expenditureLimit/limits/AGGREGATOR/PROVIDER
POST
to expenditureLimit/limits/AGGREGATOR/PROVIDER/USER
Use GET
to retrieve entities:
GET
to expenditureLimit/limits/AGGREGATOR/PROVIDER
GET
to expenditureLimit/limits/AGGREGATOR/PROVIDER/USER
GET
to expenditureLimit/balance/USER
For further documentation, you can check the API Reference available at:
End-to-End tests are described in the Installation Guide
To execute the unit tests, just run:
mvn test -fae
You can also find this documentation on ReadTheDocs