Budgea API Documentation

Budgea Development Guides Welcome to Budgea 's documentation. This documentation is intended to get you up-and-running with our APIs and advise on the implementation of some regulatory aspects of your application, following the DSP2's guidelines. Getting Started IMPORTANT Depending on your status with regard of the DSP2 regulation, agent or partner , you may call our APIs or simply use our Webview and callbacks to get the financial data of your users. As an agent , you are allowed to call directly our APIs and implement your own form to get the user's credentials. As a partner , you cannot manipulate the credentials, and have to delegate this step to us through our webview. The sections below will document how to use our APIs, make sure you have the agent status to do so. For the partner , please refer to the section Webview and Callbacks of this documentation. Overview Your API is a REST API which requires a communication through https to send and receive JSON documents. During your tests, we recommend to make calls to the API with curl or any other HTTP client of your choice. You can watch a video demonstration on this [URL](https://asciinema.org/a/FsaFyt3WAPyDm7sfaZPkwal3V). For the examples we'll use the demo API with address https://demo.biapi.pro , you should change that name to your API's name. Hello World Let's start by calling the service /banks which lists all available banks. curl https://demo.biapi.pro/2.0/banks/ To log in to a bank webpage, you'll need to know for a given bank, the fields your user should fill in the form. Let's call a specific bank and ask for an additional resource fields . curl https://demo.biapi.pro/2.0/banks/59?expand=fields The response here concerns only 1 bank (since we specified an id) and the resource Fields is added to the response thanks to the query parameter expand . To get more interesting things done, you'll need to send authenticated requests. Authentication The way to authenticate is by passing the Authorization: Bearer header in your request. At the setup a manage token have been generated, you can use this token for now, when creating your user we'll see how to generate a user's token. curl https://demo.biapi.pro/2.0/config \ -H 'Authorization: Bearer ' This endpoint will list all the parameters you can change to adapt Budgea to your needs. We've covered the very first calls. Before diving deeper, let's see some general information about the APIs. Abstract API URL https://demo.biapi.pro/2.0 Requests format Data format: application/x-www-form-urlencoded or application/json (suggested) Additional headers: Authorization: User's token (private) Responses format Data format: application/json ([http://www.json.org](http://www.json.org/)) Charset: UTF-8 Resources Each call on an endpoint will return resources. The main resources are: Resource Description --------------------- :------------------------------------------------------------------------------------------------------------------ Users Represent a user Connection A set of data used to authenticate on a website (usually a login and password). There is 1 connection for each website Account A bank account contained in a connection Transaction An entry in a bank account Investment An asset in a bank account The chain of resources is as follow: Users ∈ Connections ∈ Accounts ∈ Transactions or Investments RESTful API This API is RESTful, which means it is stateless and each resource is accessed with an unique URI. Several HTTP methods are available: Method Description ------------------------ :------------------------------- GET /resources List resources GET /resources/{ID} Get a resource from its ID POST /resources Create a new resource POST /resources/{ID} Update a resource PUT /resources /{ID} Update a resource DELETE /resources Remove every resources DELETE /resources/{ID} Delete a resource Each resource can contain sub-resources, for example: /users/me/connections/2/accounts/23/transactions/48 HTTP response codes Code Messag…