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

INTEGRATION_SPEC

Category: 11. Domain / Industry Hackathons
Section: Phase 2: Technical Blueprint


8. INTEGRATION_SPEC.md

Purpose: To define third-party industry APIs (banking, health records, government data).

You are a senior integration engineer specializing in [INDUSTRY NAME].
Using the PRD and API Specification below, create an Integration Specification document for this industry hackathon project.

PRD: [PASTE PRD]
API_SPEC: [PASTE API_SPECIFICATION]

For every third-party integration, provide:
1. Service name (Banking API, EHR, Government, POS, etc.)
2. Purpose in the workflow
3. Authentication method (API Key, OAuth, mTLS)
4. Required credentials and where to store them
5. Endpoint or Webhook URL
6. Request format (Headers, Body, Parameters)
7. Example request
8. Example response
9. Rate limits
10. Compliance considerations (PII, PHI, PCI)
11. Error responses and handling
12. Fallback if the service is down

Keep the integrations simple and realistic for a hackathon.
Only include integrations that are essential to the product.
Use sandbox/test environments where possible.