API Overview
Overview
Our 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.
Hello world
Let's start by calling the service /connectors which lists all available banks/providers.
To log in to a bank/provider webpage, you'll need to know for a given connector, the fields your user should fill in the form. Let's call a specific connector and ask for an additional resource fields.
The response here concerns only 1 connector (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 <token> header in your request. At the setup several manage tokens have been generated with the different scopes (categorization, config, invoicing and user). You can use one of these tokens for now, when creating your user we'll see how to generate a user's token.
This endpoint will list all the parameters you can change to adapt our API to your needs.
We've covered the very first calls. Before diving deeper, let's see some general information about APIs.
Abstract
API URL
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) Charset: UTF-8
Resources
Each call on an endpoint will return resources. The main resources are:
| Resources | Description |
|---|---|
Accounts | A bank account contained in a connection |
Connections | A set of data used to authenticate on a website (usually a login and password). There is 1 connection for each website. |
Documents | A document in a bank account or a provider subscription |
Investments | An asset in a bank account |
Subscriptions | A provider subscription contained in a connection (Trust only) |
Transactions | An entry in a bank account |
Users | Represent a user |
Last updated