lumapps-sdk

Lumapps SDK

LumApps SDK is a set of tools to manipulate the LumApps API

This includes:

• A client that support all the routes of the API (located in folder lumapps)
• A set of helper classes to easily manipulate LumApps elements as Python Objects and classes (folder lumapps/helpers)

Installation

pip install lumapps-sdk

Requirements

Python >= 3.8

Getting started

1. Set up your OAuth application

   Before anything else, you need to set up an OAuth application by following the steps in the LumApps Developer Portal.

2. Authenticate

   Once your application set up, get a hand on its client ID and secret, then you can write the following to get an access token for a particular user.

   from lumapps.api import BaseClient
   
   token = "MY TOKEN"
   base_client = BaseClient(
       api_info={"base_url": "https://your-cell.api.lumapps.com"}, # e.g. "https://go-cell-001.api.lumapps.com"
       auth_info={
           "client_id": "your-client-id",
           "client_secret": "your-client-secret"
       }
   )
   
   api = base_client.get_new_client_as("[e-mail]", customer_id="your-organization-id")
   

3. Make your first API call

   Let's display the full name of a registered user in lumapps

   usr = api.get_call("user/get", email="[e-mail]")
   print("Hello {}".format(usr["fullName"]))
   

Documentation

The SDK documentation is available here.

Code convention

Docstring in PEP 484 type annotations format adapted to python 3.x using comments.

How to get help, contribute, or provide feedback

Please refer to our contributing guidelines.

Copyright and license

LumApps SDK is released under the MIT license.