The FIWARE/TMForum Business API Ecosystem 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
Branch: master
Clone or download
Latest commit 8640f79 Jan 31, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
doc Update plugins guide Oct 23, 2018
docker Update docker readme file Oct 23, 2018
scripts
.gitignore Update gitignore Oct 11, 2018
CREDITS Add CREDITS file Jan 31, 2019
LICENSE Add FIWARE badges according to TSC Oct 9, 2018
README.md Move roadmap to link box Jan 31, 2019
apiary.apib Update version in apiary Oct 11, 2018
install.py Update software versions Oct 11, 2018
roadmap.md Add roadmap file Jan 25, 2019
setup_env.sh Use complete asadmin path to avoid conflicts Dec 21, 2016

README.md

Business API Ecosystem

License badge Docker Support
Documentation badge Status

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 🎓 Academy 🐳 Docker Hub 🎯 Roadmap

Contents

Background

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.

Concretely, the Business API Ecosystem is made of the following components:

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.

Description

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.

Install

The instructions to install the Business API Ecosystem can be found at the Installation Guide. You can install the software in three different ways:

Usage

The Business API Ecosystem API is build up using the APIs of the different components each exposing its own resources.

Catalog API

The Catalog API is available under /DSProductCatalog/api/ and its main resources are:

  • Categories
  • Catalogs
  • Product Specifications
  • Product Offerings

Ordering API

The Ordering API is available under /DSProductOrdering/api/ and its main resources are:

  • Product Order

Inventory API

The Inventory API is available under /DSProductInventory/api/ and its main resources are:

  • Product

Party API

The Party API is available under /DSPartyManagement/api/ and its main resources are:

  • Individual
  • Organization

Customer API

The Customer API is available under /DSCustomerManagement/api/ and its main resources are:

  • Customer
  • Customer Account

Billing API

The Billing API is available under /DSBillingManagement/api/ and its main resources are:

  • Billing Account
  • Applied Billing Charge

Usage API

The Usage API is available under /DSUsageManagement/api/ and its main resources are:

  • Usage
  • Usage Specification

RSS API

The RSS API is available under /DSRevenueSharing/rss/ and its main resources are:

  • Revenue Sharing Model
  • Transaction
  • Revenue Sharing Report

API

For further documentation, you can check the API Reference available at:

Testing

End-to-End tests

End-to-End tests are described in the Installation Guide

Unit tests

The way of executing the unit tests is described in each of the components repositories

Advanced Topics

You can also find this documentation on ReadTheDocs

Quality Assurance

This project is part of FIWARE and has been rated as follows:

  • Version Tested:
  • Documentation:
  • Responsiveness:
  • FIWARE Testing:

License

Business-API-Ecosystem is licensed under Affero General Public License (GPL) version 3.