Skip to content

softwareone-platform/mpt-api-examples

Repository files navigation

mpt-api-examples

Welcome to the mpt-api-examples repository! This is a Python-based application showing examples of how to interact with the SoftwareOne Marketplace Platform API. This project provides a simple and efficient way to interact with the SoftwareOne API, enabling various functionalities such as retrieving product information, managing subscriptions, and more.

Table of Contents

Installation

To get started with the mpt-api-examples, you need to have Python installed on your machine. You can install the required dependencies by running the following command:

pip install -r requirements.txt

Usage

Once you have installed the necessary dependencies, you can start using the API. Below are some examples to help you get started with the basic functionalities.

Examples

Initialize the Configuration with your API token

# config.py
self.mpt_platform_token = 'paste-your-token-here'

Run a sample

Each example is a standalone python script that could be launched as illustrated below, using the orders example:

python ./export-orders-sample.py

downloading orders collection: /commerce/orders?select=audit&order=-audit.created.at
  0. iterating orders offset=0 total=0 ...
collection has been retreived successfully.
total objects downloaded: 42
writing ./output/orders.json ...
saving ./output/orders.xlsx ...

Documentation

You can find the full documentation of the SoftwareOne Marketplace Platform API at SoftwareOne Platform REST API Documentation. The documentation includes detailed descriptions of the API endpoints, request and response formats, and example use cases.

Contributing

We welcome contributions to enhance the functionality of this project. If you have any suggestions, feature requests, or would like to report a bug, please open an issue or submit a pull request. For major changes, please discuss them in an issue first to ensure proper coordination.

License

This project is licensed under the Apache 2.0 License. See the LICENSE file for more details.


Thank you for using mpt-api-examples! We hope this project helps you effectively integrate with the SoftwareOne Marketplace Platform. If you have any questions or need further assistance, feel free to reach out.

Happy coding! 🚀

About

Python-based examples of how to interact with the SoftwareOne Marketplace Platform REST API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages