This article will guide you on how to create your CCB API login, enable the required service, enter into CCBChimp and authorize it.
Step 1. Login to your CCB account. NOTE: You will need to login as an administrator (or as someone with admin privileges) to create a new API user.
Step 2. Click on Settings (gear icon). From the dropdown menu, choose API.
Step 3. You will see the API summary screen. Click on Add a new API User (located to the right of the summary screen).
Step 4. You will see the New API user form. MAKE SURE YOU ARE IN THE USER TAB. Complete the form with the required information. NOTE: CCB passwords can only be characters and numbers (no special characters) with at least one number.
Step 5. Make a note of your API username and password. You will need them later.
Step 6. Click Save (located at the bottom, right-hand corner of the form).
Step 7. You will again see the API summary screen. Click on the Users tab.
Step 8. Select your user from the list of users.
Step 9: Notice that some details of the username you clicked are on display below the users list (gold box + arrow in image below). Click on this username link.
Step 10. The details page will open. Click on the Services tab.
Step 11. You will see a list of services.
You need to select the services which will allow CCB and CCBChimp to communicate correctly. Select each of these 10 services:
add_individual_to_group
create_individual
execute_search
group_participants
group_profiles
group_profile_from_id
individual_search
remove_individual_from_group
search_list
update_individual
Step 12. Click Save (located at the bottom, right-hand corner of the services list).
Step 13. You will see the API summary screen. Look at the line ‘Your API URL’. Make a note of your account name. This is the word between the double slash and the ‘.ccbchurch’. For example, in the URL “https://multisite.ccbchurch.com/api.php”, the account name is “multisite”.
Make a note of...
your API username
your API password
your API account name