{"id":13506054,"url":"https://github.com/FIWARE-TMForum/Business-API-Ecosystem","last_synced_at":"2025-03-30T03:30:39.545Z","repository":{"id":49898220,"uuid":"66840435","full_name":"FIWARE-TMForum/Business-API-Ecosystem","owner":"FIWARE-TMForum","description":"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","archived":false,"fork":false,"pushed_at":"2023-10-06T16:19:57.000Z","size":29240,"stargazers_count":38,"open_issues_count":12,"forks_count":22,"subscribers_count":13,"default_branch":"master","last_synced_at":"2024-11-01T04:35:03.388Z","etag":null,"topics":["fiware","monetization","tmforum"],"latest_commit_sha":null,"homepage":"https://business-api-ecosystem.rtfd.io/","language":"API Blueprint","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FIWARE-TMForum.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":"roadmap.md","authors":null}},"created_at":"2016-08-29T12:08:25.000Z","updated_at":"2024-09-22T16:36:57.000Z","dependencies_parsed_at":"2024-01-13T19:24:16.058Z","dependency_job_id":"ab88870c-308f-42d0-ad83-510aaf1ecfec","html_url":"https://github.com/FIWARE-TMForum/Business-API-Ecosystem","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FIWARE-TMForum%2FBusiness-API-Ecosystem","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FIWARE-TMForum%2FBusiness-API-Ecosystem/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FIWARE-TMForum%2FBusiness-API-Ecosystem/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FIWARE-TMForum%2FBusiness-API-Ecosystem/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FIWARE-TMForum","download_url":"https://codeload.github.com/FIWARE-TMForum/Business-API-Ecosystem/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246273533,"owners_count":20750904,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fiware","monetization","tmforum"],"created_at":"2024-08-01T01:00:33.831Z","updated_at":"2025-03-30T03:30:34.520Z","avatar_url":"https://github.com/FIWARE-TMForum.png","language":"API Blueprint","funding_links":[],"categories":["FIWARE Catalogue"],"sub_categories":["Context Data Publication and Monetization"],"readme":"# Business API Ecosystem\n\n[![](https://nexus.lab.fiware.org/repository/raw/public/badges/chapters/data-monetization.svg)](https://www.fiware.org/developers/catalogue/)\n[![License badge](https://img.shields.io/github/license/FIWARE-TMForum/Business-API-Ecosystem.svg)](https://opensource.org/licenses/AGPL-3.0)\n[![](https://img.shields.io/badge/tag-fiware-orange.svg?logo=stackoverflow)](http://stackoverflow.com/questions/tagged/fiware)\n[![Support](https://img.shields.io/badge/support-askbot-yellowgreen.svg)](https://ask.fiware.org)\n\u003cbr\u003e\n[![Documentation badge](https://img.shields.io/readthedocs/business-api-ecosystem.svg)](https://business-api-ecosystem.rtfd.io)\n![Status](https://nexus.lab.fiware.org/static/badges/statuses/business-api.svg) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/4964/badge)](https://bestpractices.coreinfrastructure.org/projects/4964)\n\nThe Business API Ecosystem provides sellers the means for managing, publishing,\nand generating revenue of their products, apps, data, and services. The Business\nAPI Ecosystem enables the monetization of different kind of assets (both digital\nand physical) across the whole service life cycle, from offer creation through\nto charging, accounting and revenue settlement and sharing.\n\nThis project is part of [FIWARE](https://www.fiware.org/). For more information\ncheck the FIWARE Catalogue entry for\n[Data Publication and Monetization](https://github.com/Fiware/catalogue/tree/master/data-publication).\n\n | :books: [Documentation](https://business-api-ecosystem.rtfd.io/)  |  :dart: [Roadmap](https://github.com/FIWARE-TMForum/Business-API-Ecosystem/blob/master/roadmap.md)|\n|---|---|\n\n## Contents\n\n-   [Background](#background)\n    -   [Description](#description)\n-   [Install](#install)\n-   [Usage](#usage)\n-   [API](#api)\n-   [Testing](#testing)\n-   [Advanced Topics](#advanced-topics)\n-   [Quality Assurance](#quality-assurance)\n-   [License](#license)\n\n## Background\n\nThis is the main repository of the Business API Ecosystem. This project is part\nof [FIWARE](https://www.fiware.org), and has been developed in collaboration\nwith the [TM Forum](https://www.tmforum.org/). Check also the\n[FIWARE Catalogue entry for the Business API Ecosystem](https://github.com/FIWARE/catalogue/tree/master/data-publication)!\n\nThe Business API Ecosystem is not a single software repository, but it is\ncomposed of different projects which work coordinate to provide the complete\nfunctionality.\n\nIn particular, the Business API Ecosystem is made of the following components:\n\n-   Reference implementations of TM Forum APIs.\n\n    -   [Catalog Management API](https://github.com/FIWARE-TMForum/DSPRODUCTCATALOG2)\n    -   [Product Ordering Management API](https://github.com/FIWARE-TMForum/DSPRODUCTORDERING)\n    -   [Product Inventory Management API](https://github.com/FIWARE-TMForum/DSPRODUCTINVENTORY)\n    -   [Party Management API](https://github.com/FIWARE-TMForum/DSPARTYMANAGEMENT)\n    -   [Customer Management API](https://github.com/FIWARE-TMForum/DSCUSTOMER)\n    -   [Billing Management API](https://github.com/FIWARE-TMForum/DSBILLINGMANAGEMENT)\n    -   [Usage Management API](https://github.com/FIWARE-TMForum/DSUSAGEMANAGEMENT)\n\n-   Rating, Charging, and Billing backend.\n\n    -   [Charging Backend](https://github.com/FIWARE-TMForum/business-ecosystem-charging-backend)\n\n-   Revenue Settlement and Sharing System.\n\n    -   [RSS](https://github.com/FIWARE-TMForum/business-ecosystem-rss)\n\n-   Authentication, API Orchestrator, and Web portal.\n    -   [Logic Proxy](https://github.com/FIWARE-TMForum/business-ecosystem-logic-proxy)\n\nAny feedback is highly welcome, including bugs, typos or things you think should\nbe included but aren't. To provide feedback you can use the general\n[GitHub issues](https://github.com/FIWARE-TMForum/Business-API-Ecosystem/issues/new),\nor provide it directly to the components using the\n[Charging Backend Issues](https://github.com/FIWARE-TMForum/business-ecosystem-charging-backend/issues/new),\n[RSS Issues](https://github.com/FIWARE-TMForum/business-ecosystem-rss/issues/new),\nor\n[Logic Proxy Issues](https://github.com/FIWARE-TMForum/business-ecosystem-logic-proxy/issues/new).\n\n### Description\n\nThe Business API Ecosystem is a joint component made up of the FIWARE Business\nFramework and a set of APIs (and its reference implementations) provided by the\nTMForum. This component allows the monetization of different kind of assets\n(both digital and physical) during the whole service life cycle, from offering\ncreation to its charging, accounting and revenue settlement and sharing. The\nBusiness API Ecosystem exposes its complete functionality through TMForum\nstandard APIs; concretely, it includes the catalog management, ordering\nmanagement, inventory management, usage management, billing, customer, and party\nAPIs.\n\n## Install\n\nThe instructions to install the Business API Ecosystem can be found at the\n[Installation Guide](http://business-api-ecosystem.readthedocs.io/en/latest/installation-administration-guide.html).\nYou can install the software in two different ways:\n\n-   Using Docker (recommended)\n-   Manually\n\n## Usage\n\nThe Business API Ecosystem API is build up using the APIs of the different\ncomponents each exposing its own resources.\n\n### Catalog API\n\nThe Catalog API is available under /DSProductCatalog/api/ and its main resources\nare:\n\n-   Categories\n-   Catalogs\n-   Product Specifications\n-   Product Offerings\n\n### Ordering API\n\nThe Ordering API is available under /DSProductOrdering/api/ and its main\nresources are:\n\n-   Product Order\n\n### Inventory API\n\nThe Inventory API is available under /DSProductInventory/api/ and its main\nresources are:\n\n-   Product\n\n### Party API\n\nThe Party API is available under /DSPartyManagement/api/ and its main resources\nare:\n\n-   Individual\n-   Organization\n\n### Customer API\n\nThe Customer API is available under /DSCustomerManagement/api/ and its main\nresources are:\n\n-   Customer\n-   Customer Account\n\n### Billing API\n\nThe Billing API is available under /DSBillingManagement/api/ and its main\nresources are:\n\n-   Billing Account\n-   Applied Billing Charge\n\n### Usage API\n\nThe Usage API is available under /DSUsageManagement/api/ and its main resources\nare:\n\n-   Usage\n-   Usage Specification\n\n### RSS API\n\nThe RSS API is available under /DSRevenueSharing/rss/ and its main resources\nare:\n\n-   Revenue Sharing Model\n-   Transaction\n-   Revenue Sharing Report\n\n## API\n\nFor further documentation, you can check the API Reference available at:\n\n-   [Apiary](http://docs.fiwaretmfbizecosystem.apiary.io)\n-   [Github Pages](https://fiware-tmforum.github.io/Business-API-Ecosystem/)\n\n## Testing\n\n### End-to-End tests\n\nEnd-to-End tests are described in the\n[Installation Guide](http://business-api-ecosystem.readthedocs.io/en/latest/installation-administration-guide.html#end-to-end-testing)\n\n### Unit tests\n\nThe way of executing the unit tests is described in each of the components\nrepositories\n\n## Advanced Topics\n\n-   [User Guide](doc/user-guide.rst)\n-   [Programmer Guide](doc/programmer-guide.rst)\n-   [Installation \u0026 Administration Guide](doc/installation-administration-guide.rst)\n\nYou can also find this documentation on\n[ReadTheDocs](http://business-api-ecosystem.readthedocs.io)\n\n## Quality Assurance\n\nThis project is part of [FIWARE](https://fiware.org/) and has been rated as\nfollows:\n\n-   **Version Tested:**\n    ![ ](https://img.shields.io/badge/dynamic/json.svg?label=Version\u0026url=https://fiware.github.io/catalogue/json/biz_framework.json\u0026query=$.version\u0026colorB=blue)\n-   **Documentation:**\n    ![ ](https://img.shields.io/badge/dynamic/json.svg?label=Completeness\u0026url=https://fiware.github.io/catalogue/json/biz_framework.json\u0026query=$.docCompleteness\u0026colorB=blue)\n    ![ ](https://img.shields.io/badge/dynamic/json.svg?label=Usability\u0026url=https://fiware.github.io/catalogue/json/biz_framework.json\u0026query=$.docSoundness\u0026colorB=blue)\n-   **Responsiveness:**\n    ![ ](https://img.shields.io/badge/dynamic/json.svg?label=Time%20to%20Respond\u0026url=https://fiware.github.io/catalogue/json/biz_framework.json\u0026query=$.timeToCharge\u0026colorB=blue)\n    ![ ](https://img.shields.io/badge/dynamic/json.svg?label=Time%20to%20Fix\u0026url=https://fiware.github.io/catalogue/json/biz_framework.json\u0026query=$.timeToFix\u0026colorB=blue)\n-   **FIWARE Testing:**\n    ![ ](https://img.shields.io/badge/dynamic/json.svg?label=Tests%20Passed\u0026url=https://fiware.github.io/catalogue/json/biz_framework.json\u0026query=$.failureRate\u0026colorB=blue)\n    ![ ](https://img.shields.io/badge/dynamic/json.svg?label=Scalability\u0026url=https://fiware.github.io/catalogue/json/biz_framework.json\u0026query=$.scalability\u0026colorB=blue)\n    ![ ](https://img.shields.io/badge/dynamic/json.svg?label=Performance\u0026url=https://fiware.github.io/catalogue/json/biz_framework.json\u0026query=$.performance\u0026colorB=blue)\n    ![ ](https://img.shields.io/badge/dynamic/json.svg?label=Stability\u0026url=https://fiware.github.io/catalogue/json/biz_framework.json\u0026query=$.stability\u0026colorB=blue)\n\n---\n\n## License\n\nBusiness-API-Ecosystem is licensed under [Affero General Public License (GPL)\nversion 3](./LICENSE).\n\n### Are there any legal issues with AGPL 3.0? Is it safe for me to use?\n\nThere is absolutely no problem in using a product licensed under AGPL 3.0. Issues with GPL \n(or AGPL) licenses are mostly related with the fact that different people assign different \ninterpretations on the meaning of the term “derivate work” used in these licenses. Due to this,\nsome people believe that there is a risk in just _using_ software under GPL or AGPL licenses\n(even without _modifying_ it).\n\nFor the avoidance of doubt, the owners of this software licensed under an AGPL 3.0 license  \nwish to make a clarifying public statement as follows:\n\n\u003e Please note that software derived as a result of modifying the source code of this\n\u003e software in order to fix a bug or incorporate enhancements is considered a derivative \n\u003e work of the product. Software that merely uses or aggregates (i.e. links to) an otherwise \n\u003e unmodified version of existing software is not considered a derivative work, and therefore\n\u003e it does not need to be released as under the same license, or even released as open source.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFIWARE-TMForum%2FBusiness-API-Ecosystem","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FFIWARE-TMForum%2FBusiness-API-Ecosystem","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFIWARE-TMForum%2FBusiness-API-Ecosystem/lists"}