This article will guide you on how to modify a Pushpay (CCB) API login.
Here is how to modify (edit) an existing API user.
The written walkthrough follows the video.
NOTES ABOUT THE VIDEO
(1)This video was made for another of our products, Display.Church. However, the process is the same.
(2) The video also says '13 services'. You only need 10 for CCBChimp:
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
Written Walkthrough
Log in to your Pushpay/CCB account.
NOTE: You will need to login as an administrator (or as someone with admin privileges) to modify an API user.
| Step 1: Click on Settings (blue box in image to the left) to open the dropdown menu.
If you see the API option, you have the needed permission to continue.
If you do not see this option or are unsure about anything, be in touch with your database administrator.
Step 2: Click on the API option. You will see the API summary screen (image below).
|
Step 3: Click on Users (yellow box in image below).
Step 4: Scroll down to locate the user whose API you wish to modify.
Step 5: Now click on the name of your API user.
Step 6: The details page will open.
Step 7: Click on the User tab to update the user details.
Make a note of the username and password. You will need this later to update your integration in Display.Church.
Also, you will need to tell your API User their new password (if it is not you) .
Step 8: Click on the Services tab. You will see the list of API services.
Reminder: Here are the 10 services you need:
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 8: Click Save which is located at the bottom, right-hand corner of the Services list.
Alternatively, look at the Actions menu in the upper, right-hand corner and choose Save this API User.
The screen will refresh to the API summary screen. You have now successfully modified an API user.
Now you need one more piece of information...
Look at the line ‘Your API URL’. Make a note of your account name. This is the word between the forward slash and the ‘.ccbchurch’. For example, in the URL “https://multisite.ccbchurch.com/api.php”, the account name is “multisite”.