Skip to main content

Connect Python applications with the Bigcommerce API

Project description

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
```

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

bigcommerce-api-0.9.1.tar.gz (5.8 kB view details)

Uploaded Source

File details

Details for the file bigcommerce-api-0.9.1.tar.gz.

File metadata

File hashes

Hashes for bigcommerce-api-0.9.1.tar.gz
Algorithm Hash digest
SHA256 2fe6b7178f429ec507e4085b5634825efb1aa2b84148429d7790aafb449c4c39
MD5 a24511f058e4318d94653e64ab70d208
BLAKE2b-256 d9c133d190091af5ea5b271730f29e2350aa5e19509dbacd7297e50f0e8970b4

See more details on using hashes here.

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