README.md

Usage Guide

This document explains how to upload synthetic or anonymized data into the IFC OBP Sandbox.

Python Scripts are provided which read the spreadsheets and call the OBP APIs. The following bank_ids are existing:

• 'UNIL',
• 'Telenor',
• 'ALFH',
• 'JSBL',
• 'HABB',
• 'Mobilink'

If you registered with your official business email domain, you will be granted permission to use all restricted apis needed for the data upload.

The granting of permission will take place when you login, and it can take some minutes till it is completed for the first time!

Register a User and Api Key

• get obp username and password as registered with official! bank email address here.

• create api keys here.

  For a sandbox we can use an easy access authentication, we only need the consumer_key for that.

Configure the script

Copy the script config and modify it - and add our username / password and consumer key.

• copy env_example to .env

  cp env_example .env

• add your username / password and consumer key

Copy your data set to the data sheet

We need to copy the spreadsheet template and then add your own data. Please do not change the structure of the spreadsheet in any way.

• copy resources/obp-data-import_template.xlsx to resources/obp-data-import.xlsx

  cp resources/obp-data-import_template.xlsx resources/obp-data-import.xlsx

• import your data set into the spreadsheet resources/obp-data-import.xlsx

Use the script

• create a virtual env for python:

  python -m venv venv

• install dependencies :

  pip install -r requirements.txt

• to import data run:

  python main.py