The Donorfy API enables you to integrate your web applications or backend systems with Donorfy, allowing you to retrieve and send data programmatically. This is a RESTful API designed for server-side use, so familiarity with HTTP, JSON, and authentication is essential.
Prerequisites
Subscription Level: The API is available only on Professional plans.
Enable API Access: Contact Donorfy Support to enable API access for your account.
CORS is not supported for security reasons.
API calls should originate from your server, not the browser.
This approach allows IP whitelisting and secure storage of API keys.
Setting Up API Permissions
Navigate to Settings, click API Settings in Donorfy.
Click Add Permission and provide:
Name: A descriptive label (e.g.,
WebsiteIntegration).IP Range: Start and end IP addresses allowed to access the API.
Save the permission.
An Access Key will be generated.
You can edit or delete permissions anytime.
Authentication
Basic Authentication:
Username: Any identifier (logged in the change log).
Password: Use the Access Key.
Include credentials in the Authorization header.
Base URL
https://data.donorfy.com/api/v1/<your-api-key>/
Example:
https://data.donorfy.com/api/v1/ABCDEF/
Data Format
JSON for request and response bodies.
Required header:
Content-Type: application/json
HTTP Methods
GET: Retrieve data.
POST: Create new records.
PUT: Update existing records (omit properties you don’t want to change).
DELETE: Remove records.
Key Notes
Unknown properties in requests are ignored.
Invalid values (e.g., malformed dates) are ignored.
IDs use UUIDs (GUIDs).
Date format:
Date only:
YYYY-MM-DDDateTime:
YYYY-MM-DDTHH:mm:ss.sssZ
Boolean:
trueorfalse.Numbers: Up to 2 decimal places.
Rate Limits
301 requests per minute. Exceeding this temporarily disables the API (HTTP 400).
Responses
200 OK: Success.
400 Bad Request: Invalid JSON or malformed request.
404 Not Found: Entity not found.
Resources
Interactive API Documentation.
Use tools like Postman or cURL for testing.
For troubleshooting, refer to Donorfy’s API Troubleshooting Guide.
Developer Tips
Store API keys securely (never expose them client-side).
Implement retry logic for rate-limit handling.
Log API responses for debugging and auditing.