avr/f1

Utilizes 2nd Party authentication to work with FellowshipOne's API

Fellowship One API

Interacting with Fellowship One

This package only provides 2nd Party authentication and the ability to make GET, POST, and PUT requests. You must build your own package/controllers to actually interact with Fellowship One data., _(*1)

Before starting, you need to have a "Portal User" account that is linked to a specific user in your Fellowship One database. You also must have a 2nd Party Application enabled in your church's Fellowship One admin section., _(*2)

Installation

Service Provider

Add the following to your service provider array, _(*3)

Avr\F1\F1ServiceProvider

Configuration

Copy the configuration file, _(*4)

php artisan config:publish avr/f1

Set the appropriate credentials and base URLs., _(*5)

Usage

In any class, add use F1; before the class declaration., _(*6)

The builtin F1 façade uses Guzzle's HTTP Client + OauthPlugin to make the requests. Consult their documentation for building requests and handling responses., _(*7)

For example, create a request to Fellowship One's API by using the appropriate endpoint and format:, _(*8)

$request = F1::get('v1/people/statuses.json')->send();

Using Guzzle, there are multiple ways to handle the response:, _(*9)

$response = $request->getBody(true);

Or, use Guzzle's built in json() method:, _(*10)

$response = $request->json();

Check Guzzle's documentation for more help (including leveraging Exceptions, etc)., _(*11)

Questions: @avr, _(*12)