Skip to main content

Unipag.py - Unipag Client for Python

Project description

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.defaults

# Get your key at https://my.unipag.com
unipag.defaults.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.

Install Unipag widget

Try our widget for payments workflow handling. It’s quite optional, but you might find it handy and time-saving.

<script type="text/javascript"
    src="//d3oe3cumn3db7.cloudfront.net/uw3/js/uw3.min.js"
    charset="utf-8"
    id="uw3js"
    data-key="<your-public-key>">
</script>

Please note, it is important that you use public key for widget. Public keys have restricted access to your data and are supposed to be safe for use in browser.

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.defaults
from django.http import HttpResponse, HttpResponseBadRequest

# Get your key at https://my.unipag.com
unipag.defaults.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.

Report bugs

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

Project details


Release history Release notifications

History Node

0.2.0

History Node

0.1.1

This version
History Node

0.1.0

History Node

0.0.3

History Node

0.0.2

History Node

0.0.1

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
unipag-0.1.0.tar.gz (8.3 kB) Copy SHA256 hash SHA256 Source None Jul 9, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page