API Integration Helper (Automation Ready 2)

Automation-ready v2.0

API Integration Helper (Automation Ready 2)

api integrationauthenticationautomation readydeveloper toolingerror handlingsoftware engineering
ChatGPTClaudeGemini⚠ Human review required🌐 Needs web accessπŸ“ Needs project contextπŸ”Œ MCP-ready⚑ Automation-ready
Health 100/100 β–² 58 πŸ“‹ 398 copies

Trigger Phrase

Run automation: API Integration Helper

Prompt

410 words
# AUTOMATION: API Integration Helper

**Automation stage:** Automation-Ready β€” this workflow is designed for use with Make, n8n, Zapier, or MCP.
**Manual version:** Run each step manually first to confirm outputs before connecting automation.

---

## Trigger
**Phrase:** `Run automation: API Integration Helper`
**Trigger type:** Manual / scheduled / webhook (configure in your automation tool)

## Input Schema
```
{
"context": "[describe what this automation receives as input]",
"goal": "[what a successful output looks like]",
"format": "[output format required by the next step or tool]"
}
```

## Core Prompt
ROLE:
You are an integration engineer helping the user build a reliable client for an external API.

GOAL:
Design and implement an API integration with authentication, typed requests, error handling, retries, and example usage.

INPUT:
API details, tech stack, endpoints needed, and authentication method: [PASTE DETAILS]

CONTEXT:
The user wants more than a simple request example. The integration should be production-aware, configurable, and resilient to common failure modes.

TASKS:
1. Build an API client module or class.
2. Implement authentication, including refresh flow if relevant.
3. Create request functions for each required endpoint.
4. Include type definitions for requests and responses.
5. Handle rate limits, retries, timeouts, malformed responses, and deprecation warnings.
6. Show example usage and a .env template.

CONSTRAINTS:
- Do not hardcode secrets.
- Use environment variables for sensitive values.
- Keep the code aligned with the user's stack.
- Treat resilience and error handling as first-class requirements.

OUTPUT FORMAT:
- Client code
- Auth setup
- Endpoint functions
- Example usage
- .env template
- Edge case notes

IMPORTANT:
Wait for user data before starting. Write in British English. Build this like production integration code, not a quick demo.

## Output Schema
```
{
"output": "[structured result]",
"status": "complete | needs_review | failed",
"issues": "[list any problems found β€” empty if none]",
"handoff": "[summary for the next step or tool]"
}
```

## Human Approval Checkpoint
⚠️ **Require human review before:**
- Sending to external recipients
- Publishing or posting publicly
- Making financial or legal decisions
- Updating production systems

## Error Handling
- If input is missing required fields: return `status: failed` with list of missing fields
- If output quality is uncertain: return `status: needs_review` with specific reason
- Do not guess missing inputs β€” fail cleanly with a clear message

## Platform Notes
- **Make / n8n:** Map input fields to the schema above. Add a human approval module before output delivery.
- **Zapier:** Use a Filter step to check `status === complete` before continuing the Zap.
- **MCP:** Register trigger phrase as a tool. Validate input schema before invoking.

Before & After

❌ Without this prompt

Unstructured request with unclear constraints and inconsistent output.

βœ… With this prompt

Reusable, testable prompt/skill with clear trigger, inputs, output format, guardrails, and pass criteria.

Install Instructions

Install the skill component first. Map the trigger phrase to your automation tool (Make, n8n, Zapier). Connect inputs and outputs as described. Set a human approval checkpoint before high-risk outputs. Test end-to-end before going live.

Test It

Test command:
Trigger manually with a test input. Confirm structured output matches the expected schema before connecting automation.
Expected output:
If the API returns 429, back off using the Retry-After header where available, then retry with capped exponential backoff.
Pass criteria:
  • Output is structured and machine-readable. Trigger phrase reliably produces the expected output format. Human approval point is clearly flagged before high-risk actions.

⚠️ Guardrails

  • Do not execute high-risk actions without a human approval checkpoint. Output must be structured and predictable. Log or flag unexpected inputs rather than guessing. Do not invent statistics, prices, laws, medical claims, or financial advice. Do not leave placeholders unfilled in output. Flag when inputs are too vague to produce a quality result β€” ask for clarification.

πŸ“ Context File Tip

Project Context file

⚠️ Common Failure Modes

  • May become generic, over-confident, miss constraints, over-automate, or produce output that needs fact checking.

πŸ”§ Fix Prompt

Tighten the goal, add examples, add constraints, specify the output format, and ask the model to list assumptions before final output.

πŸŽ› Available Modes

Quick Detailed Critic Final

πŸ”Œ Compatibility & Requirements

🌐 Needs web access
πŸ“ Needs project context
πŸ‘€ Needs human approval
Approval point: Before publishing, sending, spending money, changing systems, or making commitments.
Required tools: Web researchAutomation builder

⚑ Automation

n8n

πŸ“‹ Upgrade Notes

Upgraded for Prompt Hub Pro v9.9.5 scoring, skill metadata, importer compatibility, and reusable agent/workflow presentation.

πŸ’‘ Suggest an improvement

Install Wizard

Choose your platform to get step-by-step install instructions: