Integration Spec
Transform integration requirements into production-ready API specs and data contracts
What You Can Do
You'll generate detailed integration specifications that bridge business requirements and technical implementation. The skill documents API endpoints and contracts, defines field-by-field data transformations with business rules, specifies error handling and retry strategies, and establishes SLAs with monitoring criteria—giving development teams everything needed to build production-ready integrations between systems.
Features
documents endpoints, HTTP methods, authentication schemes, request/response schemas, and payload structures
field-by-field transformation definitions, type conversions, lookups, and business rule application logic
failure modes, compensation flows, fallback strategies, and recovery procedures
validation rules, enrichment steps, filtering criteria, and calculated field definitions
availability targets, performance thresholds, latency requirements, and alerting criteria
visual representation of system touchpoints, data flows, and synchronization patterns
authentication/authorization requirements, data classification, and regulatory constraints
Example Output
API Contract Example:
GET /api/v1/customers/{customerId}
Authentication: OAuth 2.0 Bearer Token
Response: {
"id": "string",
"name": "string",
"sfdc_account_id": "string (mapped from Salesforce Account.Id)",
"credit_limit": "decimal (calculated from Finance system)"
}
Data Mapping Example:
| Source Field | Target Field | Transformation | Validation |
|---|---|---|---|
| SF Account.Name | customer.name | Trim whitespace | Required, max 255 chars |
| Finance.CustomerTier | customer.tier | Map: Gold→Premium, Silver→Standard | Must match enum |
SLA Example: API Availability: 99.5% monthly uptime | Response Time: p95 < 500ms | Error Rate: < 0.5% | Sync Frequency: Every 15 minutes with 5-minute retry window
What's Included
- SKILL.md instruction file with integration specification methodology:
- API Contract Template: structured format for endpoint documentation
- Data Mapping Matrix: field transformation and validation rules template
- Error Handling & Retry Playbook: failure scenarios and recovery strategies
- SLA & Monitoring Checklist: availability, performance, and alerting criteria
Who It's For
- Business Analysts designing cross-system data flows and integration architecture
- Solutions Architects defining integration scope and technical approach for stakeholders
- Technical Leads reviewing integration requirements before development sprints
- Product Managers documenting platform integration features and API requirements
- Integration Engineers building and implementing system connectors
Best For
- Defining API contracts and integration endpoints between systems
- Creating comprehensive data transformation and mapping specifications
- Documenting error handling, retry logic, and failure compensation flows
- Establishing SLAs, monitoring criteria, and performance thresholds
- Bridging business requirements into technical implementation specifications
You might also like
Conduct comprehensive security reviews of Move and Rust smart contract code to catch vulnerabilities before mainnet deployment. Claude analyzes resource handling, witness access patterns, input validation, privilege escalation vectors, memory safety concerns, and arithmetic operations—providing concrete code remediation examples and optimization recommendations tailored to Aptos, Solana, Substrate, and Cosmos ecosystems.
by oss-appsThis skill helps you systematically assess integration needs across your systems, design architecture patterns that scale with your organization, and identify technical and operational risks before implementation. You'll receive architecture recommendations aligned to your business constraints, clear integration roadmaps, and risk mitigation strategies that reduce deployment surprises. Get structured decision records suitable for architecture review boards and engineering teams.
You can instantly access up-to-date documentation for any developer technology—from React and Next.js to Django and AWS SDKs. This skill resolves library names to their official documentation and pulls current API signatures, configuration options, and code examples, ensuring you're always working with the latest version information. Perfect for API syntax questions, version migration issues, setup instructions, and debugging library-specific behavior.
by oss-apps
You analyze your current tools and services to design automation architectures that actually work in production. This skill evaluates technology stacks (Shopify, HubSpot, Zoho, Notion, etc.), recommends whether n8n or custom code is the right choice, and provides strategic guidance on building systems that won't fail at scale. You get detailed feasibility assessments and actionable architectural recommendations tailored to your specific business needs.
by az9713