Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

API_SPECIFICATION

Category: 13. Social Impact / Civic
Section: Phase 2: Technical Blueprint


6. API_SPECIFICATION.md

Purpose: To define endpoints including government/NGO integrations.

You are a senior backend developer specializing in civic tech.
Using the PRD, Architecture, and Stakeholder Map below, create a complete API specification for this social impact hackathon project.

PRD: [PASTE PRD]
ARCHITECTURE: [PASTE SYSTEM_ARCHITECTURE]
STAKEHOLDER_MAP: [PASTE STAKEHOLDER_MAP]

For every endpoint provide:
1. HTTP method
2. URL
3. Purpose
4. Authentication requirement
5. Privacy and consent requirements
6. Request parameters
7. Request body
8. Example request
9. Example success response
10. Possible error responses
11. HTTP status codes
12. Data minimization (What data is NOT collected?)

Include endpoints for government/NGO integrations (Open Data, Eligibility checks, Reporting).
Keep the API simple and consistent.
Do not create endpoints that are not required by the product.
Prioritize privacy and data minimization.