FIWARE-TMForum / business-ecosystem-logic-proxy

Business Logic Layer for the TMForum Frameworx APIs + Portal to access them in an easy way
Other
5 stars 24 forks source link

Business Ecosystem Logic Proxy

License badge Support
Quay badge Docker badge
Docs Test Status Coverage Status

Introduction

This is the code repository for the Business Ecosystem Logic Proxy, one of the components that made up the Business API Ecosystem GE. The Business API Ecosystem is part of FIWARE, and has been developed in collaboration with the TM Forum.

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.

:books: Documentation :whale: Docker quay.io

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) defined 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; in particular, it includes the catalog, management, ordering management, inventory management, usage management, billing, customer, and party APIs.

In this context, the Business Ecosystem Logic Proxy acts as the endpoint for accessing the Business API Ecosystem. On the one hand, it orchestrates the APIs validating user requests, including authentication, authorization, and the content of the request from a business logic point of view. On the other hand, it serves a web portal that can be used to interact with the system.

Installation

The Business Ecosystem Logic Proxy is installed as part of the Business API Ecosystem, so the instructions to install it can be found at the Business API Ecosystem Installation Guide. You can install the software in two different ways:

API Reference

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

Testing

To execute the unit tests, just run:

npm test

Advanced Topics

You can also find this documentation on ReadTheDocs