thisanimus / ccb-api-connect
A utility for interacting with the Church Community Builder API.
Installs: 315
Dependents: 1
Suggesters: 0
Security: 0
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Type:project
Requires
- php: >=8.0
README
Connect to the Church Community Builder API. Use both GET and POST to interact with the CCB database. Handy documentation at https://www.ccbtutorials.com.
Installation - Compser
$ composer require thisanimus/ccb-api-connect
Config
Create a new CCB API instance by passing your API user creds to the \CCB\Api class.
$ccb = new \CCB\Api('YourApiUsername', 'YourApiPassword', 'https://YourChurchName.ccbchurch.com/api.php');
Requests
Make a request by passing parameters to the request method. Specify:
- Any query params as an associative array.
- Any curl data as an associative array.
- The request type (GET/POST).
In this example, we are requesting an individual's profile using their login/password.
$query = [ 'srv' => 'individual_profile_from_login_password' ]; $data = [ 'login' => 'ccbAccountUsername', 'password' => 'ccbAccountPassword' ]; $response = $ccb->request($query, $data, 'POST');