shirgho/Business-API-Ecosystem

Business-API-Ecosystem

• Introduction
• GEi Overall Description
• Installation
• API Overview
• API Reference
• Testing
• Advanced Topics

Introducction

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 coordinatelly to provide the complete functionality.

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

• Reference implementations of TM Forum APIs.

  • Catalog Management API
  • Product Ordering Management API
  • Product Inventory Management API
  • Party Management API
  • Customer Management API
  • Billing Management API
  • Usage Management API

• Rating, Charging, and Billing backend.

  • Charging Backend

• Revenue Settlement and Sharing System.

  • RSS

• Authentication, API Orchestrator, and Web portal.

  • Logic Proxy

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.

GEi Overall 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.

Installation

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

• Using the provided scripts
• Using a Docker Container
• Manually

API Overview

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 Reference

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

• Apiary
• Github Pages

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

• User & Programmers Guide
• Installation & Administration Guide

You can also find this documentation on ReadTheDocs