Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
branch: master
Fetching contributors…

Cannot retrieve contributors at this time

173 lines (122 sloc) 4.907 kb

Unipag Client for Python

https://travis-ci.org/unipag/unipag-python.png?branch=master

Requirements

Python version 2.6 or 2.7, or PyPy. For better security, we recommend to install Python Requests library, since it supports SSL certs verification. To install Requests, simply run:

$ pip install requests

or using easy_install:

$ easy_install requests

Requests library is optional. If it is not installed, Unipag Client will use urllib2 instead. All features of Unipag Client will remain fully functional, but it will not verify SSL certificate of Unipag API.

Installation

Install using pip, recommended (why?):

$ pip install unipag

or using easy_install:

$ easy_install unipag

Sample usage

Create invoice

import unipag
import unipag.config

# Get your key at https://my.unipag.com
unipag.config.api_key = '<your-secret-key>'

invoice = unipag.Invoice.create(
    amount=42,
    currency='USD'
)

# Done. invoice.id now contains unique id of this invoice at Unipag.

Handle webhook from Unipag

Create a standalone page on your website which will handle events sent by Unipag. Register URL of this page at https://my.unipag.com > Settings > Webhooks. Initialize page code as following (example for Django):

import unipag
import unipag.config
from django.http import HttpResponse, HttpResponseBadRequest

# Get your key at https://my.unipag.com
unipag.config.api_key = '<your-secret-key>'


def handle_unipag_hook(request):
    """
    An example of Django view for handling hooks from Unipag.
    """
    event = unipag.objects_from_json(request.body)

    # Unipag should send correctly constructed event objects
    if not isinstance(event, unipag.Event):
        return HttpResponseBadRequest('Bad request')

    # In this example we subscribe to invoice-related events only
    if isinstance(event.related_object, unipag.Invoice):

        # Always reload information from Unipag for security reasons:
        invoice = event.related_object.reload()

        # Now invoice object contains the most recent information,
        # securely loaded from Unipag.

        # ... do something with invoice data ...

    # Return HTTP 200 to let Unipag know that we successfully received message
    return HttpResponse('OK')

Tip: webhooks can be a pain to debug. Check out Unipag Network Activity log, it is available at https://my.unipag.com > Network Activity. You may find it useful for your webhook handlers debugging.

Usage of invoice "custom_data" property

Invoice objects have an optional "custom_data" property, which can be used to store up to 32KB of arbitrary data in JSON format. You can freely use this field to store additional information about invoices, which is specific for your application.

In Python, you can use dicts, lists, strings, numbers, boolean and None values in any combination to store them in custom_data. All of these types will be properly serialized when sending to Unipag and deserialized when fetching them back. Consider the following examples, all of them are valid usages of custom_data property:

import unipag
import unipag.config

# Get your key at https://my.unipag.com
unipag.config.api_key = '<your-secret-key>'

invoice = unipag.Invoice.create(
    amount=42,
    currency='USD'
)

# Store dicts, lists and single values
invoice.custom_data = {
    'address': {
        'billing': '5863 Gentle Pond Rise, Suspension, Ontario, CA',
        'shipping': '9215 Red Ridge, Lancer, Idaho, US',
    },
    'contact_phones': ['555-4242', '555-9000'],
    'magic_number': 42,
}
invoice.save()

# Clean everything out
invoice.custom_data = None
invoice.save()

# Store a single value. Yes, it will be a valid JSON.
invoice.custom_data = True
invoice.save()

# Store list as a root element. Let's assume that we need to save cart items:
invoice.custom_data = [
    {
        "product": "apples",
        "price": 10.0,
        "quantity": 1
    },
    {
        "product": "oranges",
        "price": 12.5,
        "quantity": 2
    }
]
invoice.save()

Report bugs

Report issues to the project's Issues Tracking on Github.

Jump to Line
Something went wrong with that request. Please try again.