CharityEngine Public API Documentation

Introduction

The Public API framework is a set of Web Endpoints that are created for web designers and front-end developers to harness the power of the CharityEngine platform to create amazing user experiences. These endpoints are available in both Rest and Soap protocols with JSON or XML content types to provide simple and flexible integrations in the language of your choice. These endpoints do not require credentials for integration and many will automatically identify users based on their context while visiting a CharityEngine web application. Example usages are adding payment widgets to third-party websites or social media pages, creating sign-up widgets to acquire prospect information, or customizing the user-experience by identifying visitors and personalizing what they see on web landing pages.

CharityEngine Context

A set of APIs that can be used within CharityEngine applications (e.g. PeerToPeer, CMS, Advocacy, etc.) to retreive information based on the current context.

API	Description
POST v/1/Rest/CEContext/{client_domain}/PeerToPeer/Donations	Get donations for the current microsite you are on.
POST v/1/Rest/CEContext/{client_domain}/PeerToPeer/Pages/{page_id}/Donations	Get donations for the provided page within the microsite you are on in P2P.
POST v/1/Rest/CEContext/{client_domain}/PeerToPeer/Teams/{team_id}/Donations	Get donations for the provided team within the microsite you are on in P2P.
POST v/1/Rest/CEContext/{client_domain}/PeerToPeer/Teams/{team_id}/Members	Get a list of members for the provided team within the microsite you are on in P2P.
POST v/1/Rest/CEContext/{client_domain}/PeerToPeer/Page/Donations	Get a list of donations for the current page you are on in P2P.
POST v/1/Rest/CEContext/{client_domain}/PeerToPeer/Pages	Get a list of pages for the current microsite you are on in P2P.
POST v/1/Rest/CEContext/{client_domain}/PeerToPeer/Team/Donations	Get a list of donations for the current team you are on in P2P.
POST v/1/Rest/CEContext/{client_domain}/PeerToPeer/Team/Members/{id}	Get information on a specific team member for the team you are on in P2P.
POST v/1/Rest/CEContext/{client_domain}/PeerToPeer/Team/Members	Get the list of team members for the current team you are on in P2P.
POST v/1/Rest/CEContext/{client_domain}/PeerToPeer/Pages/{id}	Get information on a specific page for the microsite you are on in P2P.
POST v/1/Rest/CEContext/{client_domain}/WebPage/Visitor	Get information about the current user visiting your application.

Public

API for retreiving data or performing actions from either inside or outside of CharityEngine applications.

API	Description
POST v/1/Rest/Public/{client_domain}/Campaigns/ListOptIn	Opt a contact into a specific list.
POST v/1/Rest/Public/{client_domain}/Donations/WebPayment	Perform a payment.
GET v/1/Rest/Public/{client_domain}/Events/{id}	Get information for the specified event.
POST v/1/Rest/Public/{client_domain}/Events	Search for events based on the supplied parameters.
GET v/1/Rest/Public/{client_domain}/PeerToPeer/Donations/{microsite_id}	Get a list of donations for the specified microsite.
POST v/1/Rest/Public/{client_domain}/PeerToPeer/Donations	Search for P2P microsite donations based on the supplied set of parameters.
POST v/1/Rest/Public/{client_domain}/PeerToPeer/Pages	Search for pages within a P2P Microsite based on the supplied set of parameters.
GET v/1/Rest/Public/{client_domain}/PeerToPeer/Pages/{microsite_id}	Get a list of pages for the specified P2P microsite.
POST v/1/Rest/Public/{client_domain}/PeerToPeer/Team/Members	Search for team members within a P2P microsite based on the supplied set of parameters.