API Integration Design & Error Handling Architect
Designs reliable API integrations with request validation, contract mapping, retries, timeout policies, idempotency, rate-limit protection, token refresh, dead-letter handling, monitoring, and recovery plans.
- Design idempotency strategies to prevent duplicate records in CRM/ERP systems.
- Create formal error taxonomies for retryable vs. non-retryable API failures.
- Develop webhook consumers with signature validation and dead-letter handling.
$55
· or 275 creditsSecure checkout via Stripe
Included in download
- Design idempotency strategies to prevent duplicate records in CRM/ERP systems.
- Create formal error taxonomies for retryable vs. non-retryable API failures.
- file_read, file_write automation included
- Ready for Compatible with ChatGPT Custom GPTs
Sample input
Design an API integration between Shopify paid orders and our ERP. Context: - Shopify is the source of truth for order creation and payment status. - The ERP is used for fulfillment and accounting. - We need to sync paid orders, customers, line items, shipping address, tax, currency, and payment status. - We are worried about duplicate orders, webhook retries, missing SKU mappings, ERP timeouts, rate limits, and partial failures. Please include: - integration architecture - data contract - field mapping approach - request validation - response validation - retry and backoff policy - idempotency strategy - rate-limit protection - dead-letter handling - monitoring and alerting - testing matrix - runbook notes
Sample output
=== API INTEGRATION DESIGN & ERROR HANDLING BLUEPRINT === Business process: Sync paid Shopify orders into the ERP for fulfillment and accounting. Systems integrated: - Source: Shopify - Target: ERP Source of truth: Shopify is the source of truth for order creation and payment status. The ERP is the source of truth for fulfillment and accounting processing after successful sync. Integration architecture: 1. Shopify order-paid webhook. 2. Webhook signature validation. 3. Event ID capture. 4. Payload validation. 5. Order transformation. 6. ERP customer lookup or create. 7. ERP order create. 8. Idempotency and state store. 9. Dead-letter handling. 10. Monitoring and reconciliation report. Data contract: Required source fields: - Shopify order ID - customer ID or customer email - line items - variant IDs or SKUs - quantity - price - currency - payment status - shipping address Required target fields: - ERP customer reference - ERP order lines - ERP item ID or SKU - quantity - price - tax - shipping method - payment status Request validation: Reject or route to review if: - Shopify order ID is missing - payment status is not paid - line items are empty - SKU mapping is missing - currency is unsupported - shipping address is incomplete - tax mapping cannot be determined Response validation: Confirm that: - ERP customer reference is returned - ERP order ID is returned - order status is accepted or created - line item count matches expected count - no partial success warning is present Idempotency strategy: Use Shopify order ID plus operation type as the idempotency key. Duplicate behavior: If the ERP order already exists, do not create another order. Update sync status and append an audit note. Retry policy: Retry timeouts, 429 responses, and selected 5xx responses with exponential backoff and jitter. Do not retry validation failures, missing SKU mappings, permission errors, or malformed requests. Rate-limit protection: Queue order sync jobs and throttle ERP requests according to provider limits. Alert if queue depth grows or repeated rate-limit responses occur. Dead-letter handling: Route failed orders to a review queue with: - Shopify order ID - correlation ID - failed step - error category - safe error message - retry count - recommended action - replay allowed flag Monitoring: Track: - orders received - orders synced - orders failed - duplicate orders prevented - retry count - ERP latency - dead-letter count - SKU mapping failures - reconciliation mismatches Testing matrix: - valid paid order - missing SKU mapping - unsupported currency - duplicate webhook event - ERP timeout before response - ERP timeout after accepting request - ERP validation error - rate-limit response - partial customer created but order failed - replay from dead-letter - reconciliation report detects unsynced paid order Runbook notes: - integration owner must review dead-letter items daily during pilot - failed SKU mappings should be assigned to operations or catalog owner - replay is allowed only after idempotency key and ERP order status are checked - production rollout should begin with a limited-volume pilot
API Integration Design & Error Handling Architect
Designs reliable API integrations with request validation, contract mapping, retries, timeout policies, idempotency, rate-limit protection, token refresh, dead-letter handling, monitoring, and recovery plans.
$55
· or 275 creditsSecure checkout via Stripe
Included in download
- Design idempotency strategies to prevent duplicate records in CRM/ERP systems.
- Create formal error taxonomies for retryable vs. non-retryable API failures.
- file_read, file_write automation included
- Ready for Compatible with ChatGPT Custom GPTs
- Instant install
Sample input
Design an API integration between Shopify paid orders and our ERP. Context: - Shopify is the source of truth for order creation and payment status. - The ERP is used for fulfillment and accounting. - We need to sync paid orders, customers, line items, shipping address, tax, currency, and payment status. - We are worried about duplicate orders, webhook retries, missing SKU mappings, ERP timeouts, rate limits, and partial failures. Please include: - integration architecture - data contract - field mapping approach - request validation - response validation - retry and backoff policy - idempotency strategy - rate-limit protection - dead-letter handling - monitoring and alerting - testing matrix - runbook notes
Sample output
=== API INTEGRATION DESIGN & ERROR HANDLING BLUEPRINT === Business process: Sync paid Shopify orders into the ERP for fulfillment and accounting. Systems integrated: - Source: Shopify - Target: ERP Source of truth: Shopify is the source of truth for order creation and payment status. The ERP is the source of truth for fulfillment and accounting processing after successful sync. Integration architecture: 1. Shopify order-paid webhook. 2. Webhook signature validation. 3. Event ID capture. 4. Payload validation. 5. Order transformation. 6. ERP customer lookup or create. 7. ERP order create. 8. Idempotency and state store. 9. Dead-letter handling. 10. Monitoring and reconciliation report. Data contract: Required source fields: - Shopify order ID - customer ID or customer email - line items - variant IDs or SKUs - quantity - price - currency - payment status - shipping address Required target fields: - ERP customer reference - ERP order lines - ERP item ID or SKU - quantity - price - tax - shipping method - payment status Request validation: Reject or route to review if: - Shopify order ID is missing - payment status is not paid - line items are empty - SKU mapping is missing - currency is unsupported - shipping address is incomplete - tax mapping cannot be determined Response validation: Confirm that: - ERP customer reference is returned - ERP order ID is returned - order status is accepted or created - line item count matches expected count - no partial success warning is present Idempotency strategy: Use Shopify order ID plus operation type as the idempotency key. Duplicate behavior: If the ERP order already exists, do not create another order. Update sync status and append an audit note. Retry policy: Retry timeouts, 429 responses, and selected 5xx responses with exponential backoff and jitter. Do not retry validation failures, missing SKU mappings, permission errors, or malformed requests. Rate-limit protection: Queue order sync jobs and throttle ERP requests according to provider limits. Alert if queue depth grows or repeated rate-limit responses occur. Dead-letter handling: Route failed orders to a review queue with: - Shopify order ID - correlation ID - failed step - error category - safe error message - retry count - recommended action - replay allowed flag Monitoring: Track: - orders received - orders synced - orders failed - duplicate orders prevented - retry count - ERP latency - dead-letter count - SKU mapping failures - reconciliation mismatches Testing matrix: - valid paid order - missing SKU mapping - unsupported currency - duplicate webhook event - ERP timeout before response - ERP timeout after accepting request - ERP validation error - rate-limit response - partial customer created but order failed - replay from dead-letter - reconciliation report detects unsynced paid order Runbook notes: - integration owner must review dead-letter items daily during pilot - failed SKU mappings should be assigned to operations or catalog owner - replay is allowed only after idempotency key and ERP order status are checked - production rollout should begin with a limited-volume pilot
About This Skill
API Integration Design & Error Handling Architect helps developers, automation engineers, SaaS teams, integration agencies, technical consultants, and companies connecting many business systems design robust API integrations between CRMs, ERPs, Shopify, HubSpot, Stripe, Airtable, Slack, Notion, Google Sheets, internal tools, and other SaaS platforms. Many enterprise automations depend on external APIs, but fragile integrations often fail because they do not properly handle malformed requests, missing fields, schema changes, authentication errors, expired tokens, permission failures, timeouts, incomplete responses, rate limits, webhook retries, duplicate requests, partial completion, and downstream system failures. This skill creates defensive API integration architectures with request validation, response validation, field mapping, schema and contract mapping, authentication planning, token refresh logic, timeout policies, retry and exponential backoff strategies, rate-limit protection, idempotency keys, error classification, ambiguous response handling, dead-letter queues, webhook reliability patterns, monitoring, alerting, testing matrices, runbooks, and remediation tickets. It is ideal for building integrations between CRMs, ERPs, ecommerce platforms, payment systems, support platforms, internal databases, workflow automation tools, communication platforms, productivity systems, and reporting tools. The skill is designed to transform fragile API flows into reliable, observable, recoverable, enterprise-grade integrations that reduce operational risk, prevent data loss, avoid duplicate records, support safe retries, and make integration failures easier to diagnose and recover from.
Use Cases
- Design idempotency strategies to prevent duplicate records in CRM/ERP systems.
- Create formal error taxonomies for retryable vs. non-retryable API failures.
- Develop webhook consumers with signature validation and dead-letter handling.
- Generate comprehensive integration testing matrices for edge-case failure modes.
- Architect token refresh and rate-limit protection for high-volume data syncs.
Known Limitations
This skill designs and audits API integrations, but it does not execute live API calls, modify production systems, verify vendor-specific behavior without documentation, guarantee uptime, replace security review, or replace compliance approval. Real reliability depends on provider behavior, implementation quality, test coverage, infrastructure, rate limits, schema stability, authentication configuration, data quality, monitoring, ownership, and ongoing maintenance. The skill may use placeholders when the user does not provide API documentation, payload samples, schema definitions, rate-limit details, authentication flow details, logs, or business-impact context. All recommendations should be validated against official provider documentation and tested in a sandbox or staging environment before production rollout.
How to Install
mkdir -p ~/.claude/skills && curl -sL https://www.agensi.io/api/install/api-integration-design-error-handling-architect -o /tmp/api-integration-design-error-handling-architect.zip && unzip -o /tmp/api-integration-design-error-handling-architect.zip -d ~/.claude/skills && rm /tmp/api-integration-design-error-handling-architect.zipFree skills install directly. Paid skills require purchase - use the download button above after buying.
Reviews
No reviews yet - be the first to share your experience.
Only users who have downloaded or purchased this skill can leave a review.
Early access skill
Be the first to review this skill.
Only users who have downloaded or purchased this skill can leave a review.
Security Scanned
Passed automated security review
Permissions
File Scopes
This skill uses file access to read user-provided API documentation, OpenAPI/Swagger files, schema files, request and response samples, webhook payload examples, integration requirements, field mapping documents, workflow exports, sanitized logs, monitoring summaries, incident reports, and business process notes. It uses write access to create structured Markdown/text outputs such as API integration blueprints, error-handling plans, contract mapping documents, retry and rate-limit policies, webhook consumer designs, fragile-flow hardening reviews, integration testing matrices, remediation tickets, monitoring plans, runbooks, and SKILL.md files. Optional API documentation, OpenAPI/Swagger, workflow export, log, webhook sample, schema, mapping, monitoring, and incident report access should remain read-only unless a separately approved implementation workflow requires otherwise. The default safe setup does not require terminal access, unrestricted network access, environment-variable access, secret-value access, production write access, database write access, deployment access, credential management access, or payment operation access.
Tags
Compatible with ChatGPT Custom GPTs, ChatGPT Agents, Claude-style workflows, Cursor, Claude Code, Codex CLI, OpenCode, Replit, API integration consulting workflows, SaaS automation workflows, backend engineering, no-code/low-code integration design, platform engineering, CRM/ERP integration planning, ecommerce operations, webhook architecture, and other AI systems that support structured Markdown instruction files such as SKILL.md. It can also be used manually in any AI chat by pasting the instructions or uploading the SKILL.md file. For production integrations, all behavior should be validated against official API documentation, sandbox environments, test payloads, provider limits, security requirements, and approved deployment procedures.