OBP-API/README.md

# README

The Open Bank Project API

## ABOUT

The Open Bank Project is an open source API for banks that enables account holders to interact with their bank using a wider range of applications and services.

The OBP API supports transparency options (enabling account holders to share configurable views of their transaction data with trusted individuals and even the public), data blurring (to preserve sensitive information) and data enrichment (enabling users to add tags, comments and images to transactions).

Thus, the OBP API abstracts away the peculiarities of each core banking system so that a wide range of apps can interact with  multiple banks on behalf of the account holder. We want to raise the bar of financial transparency and enable a rich ecosystem of innovative financial applications and services.

Our tag line is: Bank as a Platform. Transparency as an Asset.

The API uses OAuth 1.0 authentication.

The project roadmap is available [here.](https://openbankproject.com/roadmap/)

## DOCUMENTATION 

Please refer to the [wiki](https://github.com/OpenBankProject/OBP-API/wiki) to see the API specification. 

## STATUS

[V1.2.1] (https://github.com/OpenBankProject/OBP-API/wiki/REST-API-V1.2.1) is the current stable API.

## LICENSE

This project is dual licensed under the AGPL V3 (see NOTICE) and a commercial license from TESOBE
Some files (OAuth related) are licensed under the Apache 2 license.

## SETUP

The project uses Maven 3 as its build tool.

To compile and run jetty, install Maven 3 and execute:

./mvn.sh jetty:run

----

# Databases:

The default datastore used is PostgreSQL (user accounts, metadata, transaction cache).
updated the readme 2013-01-14 13:57:22 +00:00			`# README`
Initial checkin of try out code 2011-10-16 13:40:36 +00:00
readme updates 2014-12-27 18:28:18 +00:00			`The Open Bank Project API`
Initial checkin of try out code 2011-10-16 13:40:36 +00:00
updated the readme 2013-01-14 13:57:22 +00:00			`## ABOUT`
updated the API from the webapp (server) 2013-01-14 12:05:55 +00:00
Update README.md Updating the ABOUT section 2014-09-19 18:40:08 +00:00			`The Open Bank Project is an open source API for banks that enables account holders to interact with their bank using a wider range of applications and services.`
updated the API from the webapp (server) 2013-01-14 12:05:55 +00:00
readme updates 2014-12-27 18:28:18 +00:00			`The OBP API supports transparency options (enabling account holders to share configurable views of their transaction data with trusted individuals and even the public), data blurring (to preserve sensitive information) and data enrichment (enabling users to add tags, comments and images to transactions).`
Update README.md Updating ABOUT 2. 2013-01-14 16:03:32 +00:00
Update README.md Updating the ABOUT section 2014-09-19 18:40:08 +00:00			`Thus, the OBP API abstracts away the peculiarities of each core banking system so that a wide range of apps can interact with multiple banks on behalf of the account holder. We want to raise the bar of financial transparency and enable a rich ecosystem of innovative financial applications and services.`
Update README.md Updating ABOUT 2. 2013-01-14 16:03:32 +00:00
			`Our tag line is: Bank as a Platform. Transparency as an Asset.`
updated the API from the webapp (server) 2013-01-14 12:05:55 +00:00
Update README.md Updating the ABOUT section 2014-09-19 18:40:08 +00:00			`The API uses OAuth 1.0 authentication.`
updated the API from the webapp (server) 2013-01-14 12:05:55 +00:00
ihnore some tests if feature props are disabled 2015-04-24 12:43:25 +00:00			`The project roadmap is available [here.](https://openbankproject.com/roadmap/)`
added roadmap link 2013-07-19 13:49:39 +00:00
Update README.md Tweaking ABOUT etc. 2013-01-14 15:57:46 +00:00			`## DOCUMENTATION`
updated the API from the webapp (server) 2013-01-14 12:05:55 +00:00
updated the readme 2013-01-14 13:57:22 +00:00			`Please refer to the [wiki](https://github.com/OpenBankProject/OBP-API/wiki) to see the API specification.`
updated the API from the webapp (server) 2013-01-14 12:05:55 +00:00
updated the readme 2013-01-14 13:57:22 +00:00			`## STATUS`

readme and style 2015-04-01 23:32:25 +00:00			`[V1.2.1] (https://github.com/OpenBankProject/OBP-API/wiki/REST-API-V1.2.1) is the current stable API.`
updated the readme 2013-01-14 13:57:22 +00:00
			`## LICENSE`
updated the API from the webapp (server) 2013-01-14 12:05:55 +00:00
			`This project is dual licensed under the AGPL V3 (see NOTICE) and a commercial license from TESOBE`
			`Some files (OAuth related) are licensed under the Apache 2 license.`

updated the readme 2013-01-14 13:57:22 +00:00			`## SETUP`
updated the API from the webapp (server) 2013-01-14 12:05:55 +00:00
Remove sbt instructions as they don't work on many systems 2015-01-13 10:43:19 +00:00			`The project uses Maven 3 as its build tool.`
Update README.md 2013-06-22 07:17:48 +00:00
readme updates 2014-12-27 18:28:18 +00:00			`To compile and run jetty, install Maven 3 and execute:`
updated the readme 2013-01-14 13:57:22 +00:00
readme and style 2015-04-01 23:32:25 +00:00			`./mvn.sh jetty:run`
Initial checkin of try out code 2011-10-16 13:40:36 +00:00
sbt README changes and missing dependency for dev changes 2012-04-15 17:32:44 +00:00			`----`

Update README.md 2013-06-22 07:17:48 +00:00			`# Databases:`

readme and style 2015-04-01 23:32:25 +00:00			`The default datastore used is PostgreSQL (user accounts, metadata, transaction cache).`
readme updates 2014-12-27 18:28:18 +00:00