Based on the search results provided, Donorbox appears to have a REST API. The API documentation refers to REST-style endpoints and HTTP methods, uses basic authentication with an API key, and follows a typical REST API structure with endpoints like https://donorbox.org/{endpoint}
. The API also uses standard HTTP methods like GET for retrieving data from endpoints. While the search results don't explicitly state "Donorbox has a REST API", the API structure and conventions described are consistent with REST APIs.
Yes, the official Donorbox API does offer webhooks.
The Donorbox API provides webhooks for the following types of events:
In summary, the Donorbox API offers comprehensive webhook support for various events related to campaigns, donations, plans, donors, and ticket purchases. This allows for real-time integration and automation with other systems and services.
Unfortunately, I could not find specific information about the API rate limits for the Donorbox API in the provided search results. The search results contain information about Box API rate limits and general Donorbox API details, but do not mention Donorbox API rate limits.
To get accurate information about Donorbox API rate limits, I would recommend:
Checking the official Donorbox API documentation, if available.
Contacting Donorbox support directly to inquire about their current API rate limit policies.
Looking for any rate limit information in the API responses when making requests (there may be headers indicating remaining requests or rate limit status).
Starting with conservative request rates and gradually increasing to determine any practical limits through testing.
Without official documentation on rate limits, it's best to use the API responsibly and avoid making an excessive number of requests in a short time period. If you encounter any rate limiting, you may need to implement backoff and retry logic in your integration.
Based on the search results provided, here is the most up-to-date information about the Donorbox API:
The search results do not explicitly mention a specific version number for the Donorbox API. However, the API documentation refers to endpoints using the format "/api/v1/", suggesting that the current version is v1 [1].
The Donorbox API uses basic authentication, requiring an organization login email as the username and an API key as the password [1].
To access the API, users need to sign up at https://donorbox.org and enable the "API & Zapier Integration" feature, which costs $17/month [1].
The API provides endpoints for accessing campaigns, donations, donors, and plans [1][5].
All API endpoints support pagination and ordering of results [1].
The API allows filtering of results using various parameters such as date ranges, campaign names, donor information, and more [1].
Securely store your API key, as it is only shown once for security reasons [1].
Use appropriate filters to limit the data retrieved and improve performance [1].
Implement pagination when dealing with large datasets to manage resource usage [1].
Consider using environmental variables to store API credentials for better security [5].
Familiarize yourself with the available endpoints and their specific filtering options to optimize your API usage [1][5].
Here's a basic example of how to use the Donorbox API with Python, using the Parsons library:
from parsons import Donorbox # Initialize the Donorbox client donorbox = Donorbox(email='[email protected]', api_key='YOUR_API_KEY') # Get all campaigns campaigns = donorbox.get_campaigns() # Get donations for a specific campaign donations = donorbox.get_donations(campaign_name="My Campaign") # Get donors with pagination donors = donorbox.get_donors(page=1, per_page=50) # Get plans started after a specific date plans = donorbox.get_plans(date_from="2023-01-01")
This example demonstrates how to initialize the Donorbox client and make basic API calls to retrieve campaigns, donations, donors, and plans [5].
In summary, while the exact version number is not specified, the Donorbox API provides a comprehensive set of endpoints and features for accessing and managing donation-related data. Users should refer to the official documentation for the most up-to-date and detailed information on using the API.
To get started, you'll need to sign up for a regular Donorbox account at https://donorbox.org if you don't already have one.
Once you have a Donorbox account:
After enabling API access:
With your API key, you can now make API calls to Donorbox:
Based on the provided information, here are the key data models you can interact with using the Donorbox API:
Campaigns
Donations
Donors
Events (implied from Salesforce integration)
Recurring Donations
Custom Fields
While not explicitly stated as API endpoints, the Salesforce integration suggests these data models are accessible:
Contacts
Accounts
Opportunities
Key points:
Note that the full extent of the API capabilities may not be covered in the provided information, and you should refer to the complete API documentation for a comprehensive list of endpoints and operations.