API Integration Plan + Test Checklist
Engineering
Developer
Tone: Technical and systematic
Goal
Create a detailed API integration plan ensuring reliable third-party integrations with proper error handling and testing.
Context
SaaS product integrating with Salesforce API for bi-directional data sync. 2 backend engineers. 10K daily sync operations. First major integration.
Constraints
- •Salesforce 100K/day rate limit
- •Non-blocking integration
- •Graceful downtime handling
- •Data consistency required
- •Privacy-compliant logging
Do
- Document auth and token refresh
- Map endpoints and transformations
- Design retry with exponential backoff
- Comprehensive error handling
- Integration test suite
- Monitoring and alerting specs
Do Not
- Do not hardcode credentials
- Avoid synchronous blocking calls
- Do not ignore rate limits
- Avoid storing unnecessary personal data
- Do not skip load testing
Success Criteria
- Zero consistency issues in 30 days
- Reliable 10K+ daily operations
- Under 5-min error recovery
- Tests pass before release
Output Format
Integration plan document with architecture, implementation steps, and test checklist
Generated Prompt
You are a backend engineer. Create an API integration plan for Salesforce integration. ## Context SaaS product integrating with Salesforce API for bi-directional data sync. 2 backend engineers. 10K daily sync operations. First major third-party integration. ## Do - Document authentication and token refresh flow - Map all required endpoints and data transformations - Design retry logic with exponential backoff - Include comprehensive error handling strategy - Create integration test suite requirements - Add monitoring and alerting specifications ## Do Not - Hardcode credentials or tokens - Use synchronous calls that block user operations - Ignore rate limit responses - Store unnecessary personal data from API - Skip load testing before production ## Output Format Integration plan: Architecture overview, Authentication guide, Endpoint mapping, Error handling and retry, Test checklist, Monitoring setup, Rollout plan. ## Success Criteria - Zero data consistency issues in first 30 days - Integration handles 10K+ daily operations - Mean recovery time under 5 minutes
Want to customize this blueprint?
Load this example into the Blueprint Builder and adjust for your specific needs.
Open Blueprint Builder