@planningcenter/cc-api-client
A Church Center API client for use in the browser.
The intended use is from a Church Center website.
Usage from any another origin is not supported.
Usage
Nine times out of 10 we'll get by using the pre-configured sessionApiClient
.
import { sessionApiClient } from "@planningcenter/cc-api-client"
await sessionApiClient.get("/giving/v2/donations", { filter: "true" })
await sessionApiClient.post("/giving/v2/donations", { amount: 100 })
get
and post
use fetch
behind the scenes. The resolved/rejected value is guaranteed to be an object, even for empty responses and errors! If the response is ok, the promise is resolved. If the response is not ok, the promise is rejected.
sessionApiClient
has built in brains to manage authorization. It obtains an authorization token automatically. It refreshes the authorization token whenever it has gone stale.
PCO-API-Version
support is baked in, with the default "2018-08-01"
. If we need a different API version, it can be changed at the client level, or per-request.
sessionApiClient.setGlobalConfiguration({ version: "2020-11-03" })
await sessionApiClient.post(
"/giving/v2/donations",
{ amount: 100 },
{ version: "2020-11-03" }
)
Advanced Usage
If we need a custom client, buildApiClient
is available.
import { buildApiClient } from "@planningcenter/cc-api-client"
const client = buildClient({
version: "2020-11-03",
authorizationHeader: "advanced_usage_token",
})
await client.get("/groups/v2", {}, { version: "2018-08-01" })
If you want to provide an authorization token manually, you can do so.
import { sessionApiClient } from "@planningcenter/cc-api-client"
const oauthToken = {"data":{"type":"Bearer",...}}
sessionApiClient.setAuthorizationToken(window.oauth_token)
Installation
Script tag on Rails
<script
type="javascript"
src="https://unpkg.com/@planningcenter/cc-api-client/dist/url.umd.js"
></script>
Webpacker on Rails
yarn add @planningcenter/cc-api-client
import { sessionApiClient, buildApiClient } from "@planningcenter/cc-api-client"