https://github.com/impak-finance/bankin-bridge-python

A Python module for communicating with the Bridgeapi.io API.
https://github.com/impak-finance/bankin-bridge-python

bank-account bankin bankin-bridge bridge client pfm python transaction

Last synced: 2 days ago
JSON representation

A Python module for communicating with the Bridgeapi.io API.

• Host: GitHub
• URL: https://github.com/impak-finance/bankin-bridge-python
• Owner: impak-finance
• License: mit
• Created: 2018-11-16T21:42:49.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T01:19:13.000Z (about 2 years ago)
• Last Synced: 2024-08-09T17:12:25.828Z (6 months ago)
• Topics: bank-account, bankin, bankin-bridge, bridge, client, pfm, python, transaction
• Language: Python
• Size: 78.1 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
bankin-bridge-python

====================

**Bankin-bridge-python** is a Python module for communicating with the

`Bridgeapi.io API `_.

.. contents:: Table of Contents

    :local:

Main requirements

-----------------

Python_ 3.4+, Requests_ 2.0+.

Installation

------------

To install Bankin Bridge, please use pip_ (or pipenv_) as follows:

.. code-block:: shell

    $ pip install --pre bankin-bridge

Basic usage

-----------

The first step to interact with the Bankin Bridge API interface is to initialize a ``bridge.Client``

instance. You'll need a client ID and client secret this initialization:

.. code-block:: python

    >>> from bridge import Client

    >>> client = Client('', '')

Then you can easily register a new user, authenticate them and interact with the implemented

entities and the underlying API endpoints. Here are some examples:

.. code-block:: python

    >>> client.user.create('[email protected]', '')

    {'uuid': 'c3b140ad-aa85-49ca-a254-de77de521bbf',

     'resource_uri': '/v2/users/c3b140ad-aa85-49ca-a254-de77de521bbf',

     'resource_type': 'user',

     'email': '[email protected]'}

    >>> client = client.user.authenticate('[email protected]', '')

    {'access_token': '',

     'expires_at': '2018-11-19T17:20:33.546Z',

     'user': {'uuid': '12f34ca5-da8c-4ac2-8882-3e428033f300',

      'resource_uri': '/v2/users/12f34ca5-da8c-4ac2-8882-3e428033f300',

      'resource_type': 'user',

      'email': '[email protected]'}}

    >>> client.set_access_token('')

    >>> client.item.add_url()

    {'redirect_url': 'https://connect.bankin.com?token_uuid=fb12c345-b1ae-234a-1cc2-123456789dac'}

    >>> client.account.list()

    ...

Authors

-------

impak Finance .

License

-------

MIT. See ``LICENSE`` for more details.

.. _pip: https://github.com/pypa/pip

.. _pipenv: https://github.com/pypa/pipenv

.. _Python: https://www.python.org/

.. _Requests: http://docs.python-requests.org/en/master/