https://github.com/michaelborn/cfplaid
CFML wrapper for the Plaid API
https://github.com/michaelborn/cfplaid
api-wrapper cfml coldbox-modules plaid-api
Last synced: 3 months ago
JSON representation
CFML wrapper for the Plaid API
- Host: GitHub
- URL: https://github.com/michaelborn/cfplaid
- Owner: michaelborn
- Created: 2021-06-29T02:17:06.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-08-27T23:34:09.000Z (almost 3 years ago)
- Last Synced: 2025-06-03T07:56:43.698Z (about 1 year ago)
- Topics: api-wrapper, cfml, coldbox-modules, plaid-api
- Language: ColdFusion
- Homepage: https://michaelborn.github.io/cfPlaid/
- Size: 404 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# cfPlaid
Integrate with the [Plaid API](https://plaid.com/docs/api/) from CFML.
[](https://github.com/michaelborn/cfPlaid/actions/workflows/release.yml)
## Features
* Basic Account requests
* More coming soon!
## Setup
1. Install this module in your app - `box install cfPlaid`
2. Add the required configuration either via environment variables OR module settings
## Configuration
There are two ways to configure API credentials for cfPlaid:
1. Using a [`.env` file](#env-file-and-commandbox-dotenv)
2. Using [Module Settings](#module-settings)
### Env File and `commandbox-dotenv`
```bash
# Plaid API creds
PLAID_URL=https://sandbox.plaid.com
# Plaid keys
PLAID_CLIENT_ID=123_FIXME
PLAID_CLIENT_SECRET=456_FIXME
```
### Module Settings
Add the following to `config/ColdBox.cfc` and update as necessary:
```js
moduleSettings = {
cfPlaid = {
api_url : "https://sandbox.plaid.com",
api_client_id : "123_FIXME",
api_client_secret: "456_FIXME"
}
}
```
## API Docs
The cfPlaid class documentation is auto-generated via [DocBox](https://docbox.ortusbooks.com/) and hosted on Github Pages at [michaelborn.github.io/cfPlaid/](https://michaelborn.github.io/cfPlaid/)