The Business API Ecosystem provides sellers the means for managing, publishing, and generating revenue of their products, apps, data, and services. The Business API Ecosystem enables the monetization of different kind of assets (both digital and physical) across the whole service life cycle, from offer creation through to charging, accounting and revenue settlement and sharing.
This project is part of FIWARE. For more information check the FIWARE Catalogue entry for Data Publication and Monetization.
| 📚 Documentation | 🎯 Roadmap |
|---|
This is the main repository of the Business API Ecosystem. This project is part of FIWARE, and has been developed in collaboration with the TM Forum. Check also the FIWARE Catalogue entry for the Business API Ecosystem!
The Business API Ecosystem is not a single software repository, but it is composed of different projects which work coordinate to provide the complete functionality.
In particular, the Business API Ecosystem is made of the following components:
-
Reference implementations of TM Forum APIs.
-
Rating, Charging, and Billing backend.
-
Revenue Settlement and Sharing System.
-
Authentication, API Orchestrator, and Web portal.
Any feedback is highly welcome, including bugs, typos or things you think should be included but aren't. To provide feedback you can use the general GitHub issues, or provide it directly to the components using the Charging Backend Issues, RSS Issues, or Logic Proxy Issues.
The Business API Ecosystem is a joint component made up of the FIWARE Business Framework and a set of APIs (and its reference implementations) provided by the TMForum. This component allows the monetization of different kind of assets (both digital and physical) during the whole service life cycle, from offering creation to its charging, accounting and revenue settlement and sharing. The Business API Ecosystem exposes its complete functionality through TMForum standard APIs; concretely, it includes the catalog management, ordering management, inventory management, usage management, billing, customer, and party APIs.
The instructions to install the Business API Ecosystem can be found at the Installation Guide. You can install the software in two different ways:
- Using Docker (recommended)
- Manually
The Business API Ecosystem API is build up using the APIs of the different components each exposing its own resources.
The Catalog API is available under /DSProductCatalog/api/ and its main resources are:
- Categories
- Catalogs
- Product Specifications
- Product Offerings
The Ordering API is available under /DSProductOrdering/api/ and its main resources are:
- Product Order
The Inventory API is available under /DSProductInventory/api/ and its main resources are:
- Product
The Party API is available under /DSPartyManagement/api/ and its main resources are:
- Individual
- Organization
The Customer API is available under /DSCustomerManagement/api/ and its main resources are:
- Customer
- Customer Account
The Billing API is available under /DSBillingManagement/api/ and its main resources are:
- Billing Account
- Applied Billing Charge
The Usage API is available under /DSUsageManagement/api/ and its main resources are:
- Usage
- Usage Specification
The RSS API is available under /DSRevenueSharing/rss/ and its main resources are:
- Revenue Sharing Model
- Transaction
- Revenue Sharing Report
For further documentation, you can check the API Reference available at:
End-to-End tests are described in the Installation Guide
The way of executing the unit tests is described in each of the components repositories
You can also find this documentation on ReadTheDocs
This project is part of FIWARE and has been rated as follows:
- Version Tested:
- Documentation:
- Responsiveness:
- FIWARE Testing:
Business-API-Ecosystem is licensed under Affero General Public License (GPL) version 3.
There is absolutely no problem in using a product licensed under AGPL 3.0. Issues with GPL (or AGPL) licenses are mostly related with the fact that different people assign different interpretations on the meaning of the term “derivate work” used in these licenses. Due to this, some people believe that there is a risk in just using software under GPL or AGPL licenses (even without modifying it).
For the avoidance of doubt, the owners of this software licensed under an AGPL 3.0 license
wish to make a clarifying public statement as follows:
Please note that software derived as a result of modifying the source code of this software in order to fix a bug or incorporate enhancements is considered a derivative work of the product. Software that merely uses or aggregates (i.e. links to) an otherwise unmodified version of existing software is not considered a derivative work, and therefore it does not need to be released as under the same license, or even released as open source.