Cloudspot API wrapper

Basic wrapper for the Cloudspot ERP API.

Use cases

This wrapper has two use cases: 1. Authenticate and authorize users on an external app, linked to Cloudspot ERP 2. Get data (products, clients,...) from a company that is present on the Cloudspot ERP

:warning: Warning

The authentication and authorization for external apps is migrated to Cloudspot License server as of 2023-03-14. You can find the new wrapper here.

Getting started

Install

Install with pip.

pip install cloudspot-erp-api

Import

Depending on your use case, you'll need to import either CloudspotERP_UserAPI or CloudspotERP_CompanyAPI.

# Use case 1
from cloudspot.api import CloudspotERP_UserAPI

# Use case 2
from cloudspot.api import CloudspotERP_CompanyAPI

Functionalities

CloudspotERP_UserAPI

:warning: Warning

The authentication and authorization for external apps is migrated to Cloudspot License server as of 2023-03-14. You can find the new wrapper here.

CloudspotERP_CompanyAPI

This class is used to retrieve data from a company.

Setup

When setting up the class, one parameter is expected: the generated API token of the company. This token can be generated by an ERP administrator for a specific company. A token can have the right to:

• See all products
• See all clients

from cloudspot.api import CloudspotERP_CompanyAPI
api = CloudspotERP_CompanyAPI('[TOKEN]')

After setting up the connection, you can use the api to send requests to the Cloudspot ERP.

All products

Below method will allow you to retrieve all the products that are available inside the ERP and are linked to the company by the token. The .list() method will return one Artikels object, which is a list containing one or multiple Artikel objects.

artikels = api.artikels.list()

for artikel in artikels.items():
    print('naam: ', artikel.naam)

Available attributes

Following attributes are available for the Artikel object:

Specific product

Below method will allow you to retrieve a specific product by ID. Will only return the article if the article is in the company that is linked to the token. The .get(id) method will return one Artikel object.

artikel = api.artikels.get(125) # Retrieve artikel with ID 125
print('naam: ', artikel.naam)

All clients

Below method will allow you to retrieve all the clients that are available inside the ERP and are linked to the company by the token. The .list() method will return one Klanten object, which is a list containing one or multiple Klant objects.

klanten = api.klanten.list()

for klant in klanten.items():
    print('voornaam: ', klant.voornaam)

Available attributes

Following attributes are available for the Klant object:

Error handling

Basic error handling has been added. You can check if an error has occured during a call by checking the hasError attribute on the object. If the hasError attribute has been set to True, an Error object will be attached to the error attribute of the same object. The Error object contains one attribute: message. This will contain the error message.

artikels = api.artikels.list()

if artikels.hasError:
    print('error: ', artikels.error.message)