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: 16. Platform-Sponsored
Section: Phase 2: Technical Blueprint


6. API_SPECIFICATION.md

Purpose: To define endpoints including the sponsor's specific APIs.

You are a senior backend developer specializing in [SPONSOR NAME]'s APIs.
Using the PRD, Architecture, and Platform Integration below, create a complete API specification for this sponsor hackathon project.

PRD: [PASTE PRD]
ARCHITECTURE: [PASTE SYSTEM_ARCHITECTURE]
PLATFORM_INTEGRATION: [PASTE PLATFORM_INTEGRATION]

For every endpoint provide:
1. HTTP method
2. URL
3. Purpose
4. Authentication requirement (Using sponsor's auth)
5. Sponsor API used (If any)
6. Request parameters
7. Request body
8. Example request
9. Example success response
10. Possible error responses (Include sponsor-specific errors like 429 Rate Limit)
11. HTTP status codes
12. Quota and rate limit considerations

Keep the API simple and consistent.
Ensure all endpoints align with the sponsor's ecosystem.
Do not create endpoints that use competitor tools.
Prioritize showcasing the sponsor's APIs.