Evergiving API Guide¶
The Evergiving API allows other websites or apps to connect directly with Evergiving. Allowing for more streamline and accurate data communication. Some useful functions are to:
- Automatically get donation records into your accounting software
- Sync donor information with your CRM (like Salesforce)
- Build custom reports in tools like Power BI
Overall, it streamlines the integration between platforms and your digital assets, ensuring that all donation-related operations can be managed programmatically without manual intervention.
What is an API?¶
An API (Application Programming Interface) acts as a middleman between applications.
When an app or website needs to do something - say, fetch information:
- It sends a request to a specific URL (the API's address) using a method like GET or POST. This request includes required details such as parameters, data formatted in a specific way (like JSON), and often an authentication key to verify your identity.
- The server then receives the request, checks these requirements, processes the request by accessing a database or running specific logic, and finally
- Sends back a response with the data or a status message.
This entire process happens over the internet and abstracts away the complexities, allowing your app to interact smoothly with the server's services.
This is an example of what these URLs look like
https://api.evergiving.com/api/v4/leads/?duplicate_action=insert...
New to APIs? Watch This First
(4-minute overview of key concepts)
Key Features¶
Secure Data Access¶
- API Keys: Your unique digital password
- Permissions Control: Decide exactly what data external apps can access
Automatic Updates¶
- Get new donation records every 15 minutes (or set your own schedule)
- Only receive changes since your last check ("What's new?" mode)
Universal Compatibility¶
Works with:
- Business intelligence tools (Power BI, Tableau)
- CRMs (Salesforce, HubSpot)
- Custom apps (via Python/JavaScript)
Case Studies¶
In progress
Step-by-Step Setup¶
In progress
Turn this into a separate how-to
- Create API User: Create an API user in their account.
- Provide Credentials: Provide Token, Campaign ID, and Schema ID.
- Create API Schema: Set output type to 'JSON API' and add schema to the campaign.
- Testing: Submit test pledges, create conditions for testing, and verify output.
- Implementation: Remove test conditions, add production conditions, and ensure data is accurate.
Testing¶
In progress
Suggest other tools or create a separate Testing API page
Tools like Paw can be used for efficient API testing and management.