Introducing the new REST API giving realm

Posted By: Nick Floyd

The dev team has been working hard to bring you the next step in the Fellowship One REST API stack - the Giving Realm! We’ve opened up all sorts of resources to help you bring giving into your church.  From accounts to sub funds - all the resources you’ve been asking for served up on a RESTful plate.

Realms

You might also notice that we are using a new term to classify our API resource sets: REALMS. Realms are how we will be classifying groups of functionality exposed through the APIs and will help you manage your consumption through segmentation.  The realms will provide churches with the ability to allow or restrict what data consumer applications use and they will enable developers of consumer applications a platform to request specific application keys for specific functions a al carte or application keys that cover the entire stack. For instance, when requesting an API key as a developer you know that you’ll need both people and giving in your application, just request it and your key will be generated for both realms. 

image

Resources

Just as we did with the people realm we will be opening up more and more resources, so let us know what you’d like to see by chatting about it on our forum.  Note that any resource marked “3rd” will also be accessible by “1st” and “2nd” parties (if you’re not sure which one you are have a look at our authentication docs for more information).

Accounts

Batches

Contribution Receipts

Contribution Types

  • Contribution Types: List(3rd) | Show(3rd)

Funds

Pledge Drives

Remote Deposit Capture Batches (RDC)

Reference Images

Sub Funds

Get to consuming and let us know what you’re doing with the API realms via twitter or forum.

Nick Floyd is an Architect for Fellowship Technologies.  Currently he is focused on improving, designing, and building the architecture around the Fellowship One platform.  He likes learning about new technologies and languages (the obscure and the vanilla) as well as learning about new trends and practices around getting really good software from development to the users, fast.  He is passionate about software development and helping other developers.

Posted In: API, News,

Comments:
Ryan Mauer said: on March 9, 2011 at 12:40 PM

This is great! Just to be certain, it doesn’t appear there’s any way to submit actual contribution payment information on behalf of a user to be processed by our payment gateway (for example, to implement a custom giving experience). Is that correct?

Michael Espinosa said: on March 9, 2011 at 01:40 PM

Great work dev team! I have the same question as Ryan, are there any methods to implement our own custom giving experience?

Nick Floyd said: on March 9, 2011 at 02:35 PM

@Ryan and @Michael:

Right now we wanted to provide a solution to fulfill the recording of payments that happen outside of our system (like a realtime kiosk, a square implementation, or paypal and the like.  We do have a payment gateway API that we hope to deprecate that communicates directly with Cybersource - that particular API, we have discovered, was too rigid of an implementation; it’s covered in our business rules and really is customized for our implementation, not yours.

I am sure your scratching your head thinking, yes that’s what we want - accept payments on our site and pass them through to the processor we use with all other Fellowship One products.  However, we have come to realize that for this type of need a mashup sans our business rules is far more appropriate for many of our consumer’s needs. 

So, for instance, you have an online book store and want to use Cybersource as the processor and FellowshipOne to record the data - mashup your bookstore with the CBYS API using the same key use use in Fellowship One (http://www.cybersource.com/support_center/implementation/downloads/) and push data to FellowshipOne via Giving realm.

I imagine that sometime in the future it might be possible to process payments through our giving realm but I imagine if might be fairly generic - we’ve really seen the power of sometimes getting our business rules out of your way and letting you roll your own implementations through our APIs and others.

Let me know what your specific thoughts are on this - I’d love to talk to you about what growing out our feature set might look like.

Jonathan Puddle said: on April 12, 2011 at 12:15 AM

Is it possible to query the donations history with this API Realm, rather than write to it? We do all our accounting in an enterprise accounting product, and need to export all transactions to GL entries.

Nick Floyd said: on April 12, 2011 at 06:46 AM

@jonathan Puddle

Yes, you can use the following parameters with a contribution search (http://developer.fellowshipone.com/docs/giving/v1/ContributionReceipts.help#search):
batchID = search for receipts containing the batchID this is passed with this parameter.
individualID = search for receipts containing the individualID that is passed with this parameter.
householdID = search for receipts containing the householdID that is passed with this parameter.
startReceivedDate = search for receipts with a received date greater than or equal to this parameter.
endReceivedDate = search for receipts with a received date less than or equal to this parameter. Must be used in conjunction with startReceivedDate.

Jonathan Puddle said: on April 12, 2011 at 06:59 AM

Sweet, thanks Nick!

Commenting is not available in this channel entry.

Categories:

Previous Posts:


Subscribe to the RSS feed!