isabella232 / wstore

WStore provides functionality for the monetization of different kind of digital assets, including the management of assets and offerings as well as support for acquisitions, charging, billing, and accounting of pay-per-use services.

WStore

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

Introduction

This is the code repository for WStore, the reference implementation of the Store GE.

This project is part of FIWARE. Check also the FIWARE Catalogue entry for WStore!

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.

You can find the User & Programmer's Manual and the Administration Guide on readthedocs.org

GEi Overal Description

WStore provides functionality for the monetization of different kind of digital assets, including the management of assets and offerings as well as support for acquisitions, charging, billing, and accounting of pay-per-use services.

Installation

The instructions to install WStore 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

WStore API is available under /api/ path, and the main available resources are:

• Offerings /api/offering/offerings
• Resources /api/offering/resources

With these resources you can:

• Use POST to create entities:
  • Create a resource making POST to /api/offering/resources
  • Create an offering making POST to /api/offering/offerings
• Use GET to retrieve entities:
  • Retrieve a collection of resources making GET to /api/offering/resources
  • Retrieve a collection of offerings making GET to /api/offering/offerings
  • Retrieve an offering making GET to /api/offering/offerings/ORG/NAME/VERSION
• Use PUT to update entities:
  • Update a resource making PUT to /api/offering/resource/ORG/NAME/VERSION
  • Update an offering making PUT to /api/offering/offerings/ORG/NAME/VERSION
• Use DELETE to remove entities:
  • Remove a resource making DELETE to /api/offering/resource/ORG/NAME/VERSION
  • Remove an offering making DELETE to /api/offering/offerings/ORG/NAME/VERSION

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

To execute the unit tests, just run:

python manage.py test

Advanced Topics

• User & Programmers Guide
• Installation & Administration Guide

You can also find this documentation on ReadTheDocs