Introduction
Changelog
Usage
Authentication
Headers
Errors
Rate Limiting
Webhooks
OAuth 2.0
User
Devices
Aggregation
Bills
Budgets
Challenges
CDR
Configuration
Contacts
Events
Goals
Messages
Pay Day
Payments
Reports
Surveys
Calculators
Images
Financial Passport
Users
Accounts
Transactions

Usage

Client API

The Client API comprises of the user facing features such as fetching transactions or managing bills and is designed for a client app or website to use. Every endpoint within the Client API is user-scoped, meaning that only data on information relating or belonging to that user can be accessed using this API.

Example use cases the Client API should be used for:

  • Building an app to directly interface with Frollo
  • Integrating with Frollo directly for end users into an existing app
  • Building web SPAs

Management API

The Management API is designed to be used in a machine to machine (M2M) context to allow management of users, accounts and transactions on the Frollo platform.

The Management API can also be used to access the Client API endpoints by providing the User ID as a header to a specific endpoint. See here for details: Authentication

Example use cases the Client API should be used for:

  • Providing realtime data to Frollo such as Users, Accounts and Transactions
  • Integrating Frollo via an existing integration platform by using Client APIs in an M2M context
  • Utilising features designed for M2M consumption such as Affordability Reports