Skip to main content
Warning: You are using the test version of PyPI. This is a pre-production deployment of Warehouse. Changes made here affect the production instance of TestPyPI (testpypi.python.org).
Help us improve Python packaging - Donate today!

The Python client library for the Beans API

Project Description

Beans-SDK-Python
================

[Beans](http://loyalbeans.com) SDK allows you to easily integrate a loyalty program in your application.

Install
-------

We recommend installing with pip.
```sh
pip install beans
```

Usage
-----

Beans SDK needs [Beans Plugin](http://business.loyalbeans.com/developers) in order to correctly work.

The following is the syntax for making API requests:
```python
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](http://business.loyalbeans.com/doc/introduction/)
- [action] : Each module supports multiple actions such as add or get.
- [cookies]: cookies associated to the request
- [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](http://business.loyalbeans.com).


Example and error handling
--------------------------

```python
# 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](http://business.loyalbeans.com/page/api_doc/)

Python Version Supported
- 2.7
- 3.3
- 3.4

Release History

This version
History Node

1.0.1

History Node

1.0.0

Download Files

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

Filename, Size & Hash SHA256 Hash Help File Type Python Version Upload Date
beans-1.0.1.tar.gz
(3.6 kB) Copy SHA256 Hash SHA256
Source None Jun 21, 2014

Supported By

Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Google Google Cloud Servers DreamHost DreamHost Log Hosting