Skip to content

Home

Jump to bottom Edit New page
Simon Redfern edited this page Oct 30, 2015 · 57 revisions

####Hello!

Welcome. This page is about the General OBP API sandbox.

####TL;DR

There are three services of interest when using the OBP sandbox

  1. The actual OBP API:

https://apisandbox.openbankproject.com/

  1. The API Explorer:
  • It's better to use this domain rather than other links to similar pages:

https://apiexplorersandbox.openbankproject.com

  1. Social Finance: (This app can be used to browse the accounts, transactions, edit counterparties etc.)

https://sofisandbox.openbankproject.com/

  1. Example bank customer login:

Robert, married, retired 63, no mortgage runs a charity has savings.

robert.x.d.n@example.com / 8596d7de

The logins above and below are valid for all three services since 2 and 3 above are Apps that authenticate against the API using OAuth just like any other App.

Note that developers register yourselves as developers (to get your API keys), so once you have done that, you should logout and login as a customer in order to see some transaction data.

####Overview Open Bank Project is an open source API for banks providing a common RESTful interface for developers to build customer facing applications. You can use it as a flexible toolbox of data and services to help realise (a.k.a. hack!) your ideas together. For the hackathons, developers have access to simulated transaction data for imaginary customers.

####What sort of applications can I build with the OBP API? Customer facing retail banking and fintech applications for consumers, SMEs, associations, charities, governments and NGOs; including (but not limited to!) Personal Finance Management (PFM) Solutions, online accounting integration, financial widgets, Savings Apps, Education Apps, Gamification, Peace of Mind Apps, Transparency Apps, Crowd funding, on boarding, CRM etc..

####What data and services can I access?

  • Account information, balance and transaction history of multiple bank accounts
  • Enrich bank transactions with metadata (tags, comments, urls and geolocation) for example to link a receipt or video to a transaction
  • Create/Access different views on accounts. Each view grants a subset of the data to a restricted group of users. For example, a customer could offer special views on his account to his accountants, auditors or regulators. A charity might open their accounts to the public
  • Initiate payments
  • Access Customer messages
  • Access data related to branches, ATMs and financial products

####API Endpoint: https://apisandbox.openbankproject.com/obp/v1.4.0

####API Explorer: Use the OBP API Explorer to browse and test the API.

####This OBP instance contains simulated test accounts for test banks:

####Public Data Some sandbox data has a public view available, which does not require OAuth to access. For example, here is a list of transactions: https://apisandbox.openbankproject.com/obp/v1.2.1/banks/rbs/accounts/savings-kids-john/public/transactions

####Important Note to Developers: In order to build and test your Apps, you will use two different logins:

    1. Your developer login to get your API keys (see Application registration below)
    1. One or more simulated customer logins to access transaction data etc. (See customer logins below)

####Application registration Please register your application here. You will get a consumer key and consumer secret for the calls requiring OAuth authentication.

####OAuth To get started with OBP and OAuth we recommend you use (and fork) one of our Starter SDKs / snippets:

Note: Make sure you use the correct domain in all calls i.e. apisandbox.openbankproject.com !

####FAQ:

Technical details about the OAuth flow including getting a request token, redirecting the user, getting an access token and accessing protected resources are available here. Please ask us (see below) if you are stuck with this. Also you may like to use this tutorial on OAuth

####API documentation

####Customer logins

During the OAuth login, the user of your app will be asked for a customer username/password.

Here are some simulated customer logins to test your App / OAuth flow:

joe.bloggs@example.com / qwerty

Robert, married, retired 63, no mortgage runs a charity has savings.
robert.x.d.n@example.com / 8596d7de

Susan 39 single mum of two  works a admin job. Rents.
susan.x.d.n@example.com / c979bc0f

Anil, single 21 has his own business, owns a house, nice car and disposable income.
anil.x.d.n@example.com / 3597ea23

Ellie 26, works in retail, married. Husband has good job. Her money is all for luxuries.
ellie.x.d.n@example.com / b1db8ad6

robert.y.f.n@example.com / 6392db56

susan.y.f.n@example.com / 437061c4

anil.y.f.n@example.com / f7de9f2b

ellie.y.f.n@example.com / a2354110

To get different logins just for you / your team please ask a member of the Open Bank Project team.

You can use this application which also uses OAuth to browse your transaction data (use the above username/passwords).

####Questions / Contact?

Add a custom footer
Add a custom sidebar
Clone this wiki locally