This article explains how to test your integration by using the CSR Partner Testing Portal.
CSR Partner Portal walkthrough
How to Perform a Test Using the Test Wizard
To TEST your integration, you will need:
-
Your Test API key
To make LIVE changes in production, you will need:
- Your Production API key
CSR Partner Portal walkthrough
You can access the corporate vendor CSR Partner Portal at this URL: https://doublethedonation.com/corporate-vendor/#/vendor-auth
After accessing the CSR Partner Portal, you will be prompted to enter your Test API key OR your Production API key. Please ensure you're using the correct key based on your desired outcomes.
The Production and Test API Keys will create very similar portals. The Production API key affects the live Double the Donation database accessed by thousands of nonprofit clients.
After logging in, you will be able to view which environment you are accessing in the top left corner of the portal.
Test Environment
Once you log in using your TEST API Key, the homepage will appear as follows:
Tabs you'll see on the left-hand side are Testing, Swagger API, and Profile.
How to Perform a Test Using the Testing Wizard
New Donation Test
The Testing Wizard can be found under Testing > New Donation Test. In the New Donation Test wizard, you can simulate the entire auto-submission process end-to-end. Each step of the wizard represents an action taken by a designated stakeholder on a particular platform, which will be indicated at the top of the wizard screen, which outlines WHO is the user taking an action, WHERE (on which platform) the action is taking place, and WHAT action is being taken by the user. The New Donation Test Wizard will show helpful hints and applicable information as you move through the testing process.
The New Donation Test wizard will walk you through five steps, where you will perform a test acting as the appropriate stakeholder:
1. Donor (employee) submits a donation on a nonprofit's donation page
2. Donor (employee) auto-submits a matching gift request on a nonprofit's confirmation page, within the 360MatchPro matching gift plugin
3. Your platform uses 360MatchPro's auto-submission APIs to pick up the matching gift request. 4. Your platform processes the matching gift request according to the company guidelines and your own personal processes.
5. Your platform sends matching gift status updates to 360MatchPro to present to the nonprofit.
Click "Begin Test" to begin.
STEP 1: "Submit Donation"
In this step, you act as a donor (employee of your platform's client company), making a donation on a nonprofit's donation form.
-
Enter a first name, last name, email address, and donation amount for this test donation. Choose the [Your Platform] Test Company from the Company drop down.
You should ONLY use the company entry labeled [Your Platform] Test Company when using the Testing Wizard.
-
Click "Create Test Donation", then "Next".
STEP 2: "Submit Matching Gift Request"
In this step, you act as a donor (employee of your platform's client company), auto-submitting a match request from a nonprofit's confirmation page.
-
The [Your Platform] Test Company you selected in Step 1 will be prepopulated in the 360MatchPro matching gift plugin. The plugin should say "Let's get your gift matched!" and include the matching gift information/program parameters you set within the "Manage Company Programs" tab (see documentation).
-
Complete the verification process, select the checkbox, and click "Submit Request".
-
The plugin will then display a success message and a message about your platform.
-
Click "Next".
STEP 3: "Pick Up Matching Gift Request"
In this step, you are able to test your platform's implementation of auto-submission.
-
The wizard will show you a view of the 360MatchPro Corporate Vendor API Swagger Page, with the appropriate API endpoint expanded for use. The endpoint you should use is /get-updated-donations.
-
Use the API to pull the donation and match request data into your platform.
-
Click "Next".
STEP 4: "Process Matching Gift Request"
In this step, you process the match request as normal in your own platform.
-
Now that you have the matching gift request in your platform, process it according to your internal processes. This step takes place entirely on your platform.
-
Once the processing is complete, click "Next".
STEP 5: "Update Matching Gift Status"
Complete this step to give the nonprofit insight into the approval and fund disbursement stages of the match request.
-
The wizard will show you a view of the 360MatchPro Corporate Vendor API Swagger Page, with the appropriate API endpoint expanded for use. The endpoint you should use is /update-donation.
-
Use the API to update the status of the match request for the 360MatchPro nonprofit client.
-
You will see the status updates you send reflected below under "360MatchPro" view (scroll down to find). This shows an example of what the donation record (and status) looks like for the nonprofit. Ensure that as you send the status update, this change is reflected in the donation record. Click "Refresh Donation Details" to see the change in status reflected.
-
Click "Finish".
Congratulations! You have made a successful test of auto-submission using the New Donation Testing Wizard. You'll immediately see your Test History within the Donation Test History view after completing the necessary steps with the wizard.
Update Company Test
Under Testing > Update Company Test, you can test adding a matching gift program or update an existing program in the Double the Donation database.
To add a new test company, use the “New” button. New companies can only be added manually both within the test environment and production environments.
To update an existing company in the database, use the “update-company” endpoint available in the Swagger API tab and your Test API key.
Program details changed using the test API key will update in real time and be visible in the Update Company Test tab.
Production Environment
Tabs you’ll see on the left-hand side are Manage Company Programs, Nonprofits, Swagger API, and Profile.
Manage Company Programs
New companies can only be added to the Double the Donation manually. The Double the Donation team manually reviews all new company program submissions for quality assurance.
Within the Manage Company Programs tab, you can make or withdraw claims for existing companies within the database.
Within the Manage Company Programs tab, you’ll see all of your currently claimed companies labeled “Companies”.
To update the program parameters of an existing company in your production environment, use the “update-company” endpoint and your production API key. Updates made using your test API key are subject to review by the Double the Donation team before being updated.
For more information on updating company program information, visit our Update Company Program Information Guide.
Troubleshooting
Q: The partner portal/testing wizard/API/integration is not operating as expected.
A: Please contact partners@doublethedonation.com or your main point of contact at Double the Donation for assistance.