Skip to main content

The Python client library for the Beans API

Project description

Beans SDK allows you to easily integrate a loyalty program in your application.

Install

We recommend installing with pip.

pip install beans

Usage

Beans SDK needs Beans Plugin in order to correctly work.

The following is the syntax for making API requests:

import beans

# Initialize the API
beans.initialize('SECRET_KEY')

beans.business.call(function='[module]/[action]/', [params], [cookies])
  • [module] : The module to call, e.g. reward. Module list

  • [action] : Each module supports multiple actions such as add or get.

  • [params] : Arguments as dictionary (optional)

A secret key is required for using the SDK. To get a secret key, need to have a Business account on Beans.

Example and error handling

# Check if the user possess your card
is_beans_card = beans.business.call(function='card/check/', cookies=request.cookies)

# Add 1000 beans point to the user card
if is_beans_card:
    try:
        arg = {'beans': 1000}
        beans.business.call('beans/add/',params=arg, cookies=cookies)
    except beans.BeansException as e:
        print(e)

Here is the List of API methods

Python Version Supported - 2.7 - 3.3 - 3.4

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

beans-1.0.1.tar.gz (3.6 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page