Welcome to DonaSF API
DonaSF is a RESTful API built with ASP.NET Core for managing donations, donors, missionaries, and administrators in a donation tracking system. This documentation will guide you through setting up, configuring, and integrating with the API.Quick Start
Get up and running with DonaSF API in minutes
Authentication
Learn how to authenticate your API requests
Architecture
Understand the system architecture and design
API Reference
Explore the complete API endpoint documentation
Key Features
DonaSF API provides a complete solution for donation management with the following capabilities:Donation Management
Complete donation lifecycle tracking with unique codes and status monitoring
Multi-Role System
Support for administrators, missionaries, and donors with role-based access
JWT Authentication
Secure authentication and authorization using JSON Web Tokens
Receipt Tracking
Comprehensive voucher and cash delivery management
Email Notifications
Automated email notifications via Twilio integration
SQL Server Backend
Robust data persistence with stored procedures and optimized queries
Architecture Overview
DonaSF follows a three-tier architecture pattern:- Presentation Layer - ASP.NET Core Web API controllers handling HTTP requests
- Business Logic Layer - Business rules and domain logic implementation
- Data Access Layer - SQL Server database interactions with stored procedures
The API is built on .NET 10.0 and uses Microsoft SQL Server for data persistence.
API Endpoints
The API provides endpoints organized by resource type:- Donations - Create and view donations
- Donors - Manage donor information
- Missionaries - Handle missionary records
- Administrators - Administer system users
- Donation Keys - Manage donation tracking codes
- Vouchers - Track donation receipts
- Cash Delivery - Monitor cash donation deliveries
- States - Access system state data
- Editions - Manage donation campaigns or editions
Getting Started
Ready to start using DonaSF API? Here’s what you need to do:Set up your environment
Install .NET 10.0 SDK and SQL Server. Follow our setup guide for detailed instructions.
Configure the application
Set up your database connection, JWT secrets, and email configuration. See the configuration guide.
Authenticate
Obtain a JWT token to authenticate your API requests. Learn more in the authentication guide.
Continue with Quick Start
Follow our quickstart guide to make your first API call