janrain-python-api 0.2.3

Python interface to the Janrain Capture API.

Python interface to the Janrain Capture API.

Install

Download and install the most recent stable version using pip (preferred):

pip install janrain-python-api

… or using (easy_install):

easy_install janrain-python-api

To use the unstable developement version, download the package by cloning the git repository:

git clone https://github.com/janrain/janrain-python-api.git
cd janrain-python-api
python setup.py install

Basic Usage

Low-Level API Calls

Use janrain.capture.Api to make low-level calls to the API.

from janrain.capture import Api

defaults = {
    'client_id': "YOUR_CLIENT_ID",
    'client_secret': "YOUR_CLIENT_SECRET"
}

api = Api("http://YOUR_APP.janraincapture.com", defaults)
result = api.call("entity.count", type_name="user")
print(result)

Exceptions

Exceptions are derived from JanrainApiException which includes error responses from the API. A try/catch bock should wrap any functions or methods that call the Janrain API.

try:
    result = api.call("entity.find", type_name="user")
except janrain.capture.InvalidApiCallError as error:
    # 404 error
    sys.exit("Invalid API Endpoint: " + error.message)
except janrain.capture.ApiResponseError as error:
    # API returned an error response
    sys.exit("API Error: " + error.message)

Command-Line Utility

The package installs an executable named capture-api for making API calls from the command-line.

Authenticate with the API by passing --api-url, --client-id, and --client-secret, then pass the API call, and then any parameters to send to the API as key=value pairs after the --parameters argument.

Examples

Passing the authentication credentials:

capture-api --api-url=[YOUR_CAPTURE_URL] \
            --client-id=[YOUR_CLIENT_ID] \
            --client-secret=[YOUR_CLIENT_SECRET] \
            entity.count --parameters type_name=user

Enclose JSON values in single outer-quotes and double inner-quotes:

capture-api --api-url=[YOUR_CAPTURE_URL] \
            --client-id=[YOUR_CLIENT_ID] \
            --client-secret=[YOUR_CLIENT_SECRET] \
            entity.find --parameters type_name=user \
            attributes='["displayName","email"]'

Enclose filters in double outer-quotes and single inner-quotes:

capture-api --api-url=[YOUR_CAPTURE_URL] \
        --client-id=[YOUR_CLIENT_ID] \
        --client-secret=[YOUR_CLIENT_SECRET] \
        entity.find --parameters type_name=user \
        filter="email = '[e-mail]' and birthday is null"

---

Copyright © 2013 Janrain, Inc. All Rights Reserved.