skip to navigation
skip to content

Not Logged In

bigcommerce-api 0.9.1

Connect Python applications with the Bigcommerce API

Latest Version: 0.10.1

Bigcommerce API V2 - Python Client
==================================

Lightweight wrapper over the `requests` library for communicating with the Bigcommerce v2 API.


Needs `requests` and `streql` (run `pip install bigcommerce-api` for easiest way to install),
and `nose` and `vcrpy` if you want to run the tests.

Basic usage

of Connection:
```python
import bigcommerce as api  # imports Client, Connection, OAuthConnection, and HttpException classes

from pprint import pprint  # for nice output
```
```python
# connecting with basic auth and API key
HOST = 'www.example.com'
AUTH = ('username', 'apikey')

conn = api.Connection(HOST, AUTH)
pprint(conn.get('products', limit=5)  # supply any query parameter as a keyword argument
p = conn.get('products/35')
print p.id, p.name  # p is a Mapping; a dict with . access to values

p = conn.update('products/{}'.format(p.id), {'name': 'Something Else'})
print p.id, p.name

imgs = conn.get('products/{}/images'.format(p.id))
# ... and etc
```

and of OAuthConnection
```python
# after registering your app to get client id and secret
# and in your callback url handler, which should be passed code, context, and scope

conn = api.OAuthConnection(client_id, store_hash)  # store hash can be retrieved from context
# login_token_url is most likely "https://login.bigcommerceapp.com/oauth2/token"
token = conn.fetch_token(client_secret, code, context, scope, redirect_uri, login_token_url)
# conn can now be used like a Connection object to access resources


# if you already have the user's access token, simply do
conn = OAuthConnection(client_id, store_hash, access_token)

# and for constant-time verification of the signed payload passed to your load url
user_data = api.OAuthConnection.verify_payload(signed_payload, client_secret)  # returns False if authentication fails
```
 
File Type Py Version Uploaded on Size
bigcommerce-api-0.9.1.tar.gz (md5) Source 2014-01-07 5KB
  • Downloads (All Versions):
  • 74 downloads in the last day
  • 461 downloads in the last week
  • 1185 downloads in the last month