Skip to content

Lumapps SDK¤

Action Status Pypi Coverage Black Black

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

Getting started¤

  1. Get your token

    LumApps supports multiple ways of authentication. The fastest one to implement is the following:

    Get your token by logging to your LumApps account. Go to https://sites.lumapps.com and authenticate. Once connected, open the javascript console of your browser and run:

    var instance = window.location.pathname.split('/');
    instance = instance[1] == "a" ? instance[3] : instance[1]
    fetch(window.location.origin+"/service/init?customerHost="+window.location.host+"&instanceSlug="+instance+"&    slug=").then(data=>{return data.json()}).then(res => {console.log(res.token)})
    

    This will generate your personal LumApps token that will be active for 60 minutes, and that we will use in the following steps

  2. Authenticate

    from lumapps.api import ApiClient
    
    token = "MY TOKEN"
    client = ApiClient(token=token)
    
  3. Make your first API call

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

    user_email = "YOUR EMAIL"
    usr = api.get_call("user/get", email=user_email)
    print("Hello {}".format(usr["fullName"]))
    

Documentation¤

The SDK documentation is available here.

Code convention¤

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

How to get help, contribute, or provide feedback¤

Please refer to our contributing guidelines.

LumApps SDK is released under the MIT license.