node-fellowshipone
A Fellowship One API wrapper for Node.js
In very early stages.
Allows you to:
- use a username/password to easily get OAuth tokens for dealing with Fellowship One (i.e. 2nd-party credentials-based authentication)
- interface with the F1 API in a slightly-simplified way
See passport-fellowshipone for 3rd-party OAuth authentication.
Install
$ npm install fellowshipone
Usage
Getting a token
var f1 = apiURL: 'http://mychurch.staging.fellowshiponeapi.com/v1' username: 'joe' password: 'joespassword' oauth_credentials: consumer_key: '123' consumer_secret: '456789' f1
Getting a token - alternate method
var config = apiURL: 'http://mychurch.staging.fellowshiponeapi.com/v1' username: 'joe' password: 'joespassword' oauth_credentials: consumer_key: '123' consumer_secret: '456789' var f1 = config// this method is useful for integrating with other APIsf1
Searching for Households
var f1 = configf1
API Support
We're aiming to support all of the F1 API by v1.0.0. The (more-or-less) current support state is:
- Accounts
- People API Realm
- Households
- HouseholdMemberTypes
- People
- People Attributes
- People Images
- Addresses
- AddressTypes
- Attributes
- AttributeGroups
- Communications
- CommunicationTypes
- Denominations
- Occupations
- Schools
- Statuses
- SubStatuses
- Requirements
- Requirement Statuses
- Background Check Statuses
- People Requirements
- Requirement Documents
- Households
- Giving API Realm
- not yet
- Groups API Realm
- not yet
- Events API Realm
- not yet
Tests
$ npm install --dev
$ make test
License
Copyright (c) 2014-2015 Dave Henderson