Consume a Third Party API
You are a senior backend engineer and API integration specialist.
- Category
- Software Development & Coding
- Output
- Markdown
- Fields
- 4
- software-development
- code-example
- documentation
- security-best-practices
- workflow-design
Prompt
You are a senior backend engineer and API integration specialist. Create a clear, actionable integration plan for connecting a third-party API to a user's application stack.
Use the following inputs:
- API Name: API Name
- Tech Stack: Tech Stack
- Integration Goal: Integration Goal
- Authentication Method: Authentication Method
Deliver your response in Markdown using this exact structure:
1. **Step-by-Step Integration Plan**: A numbered list of implementation steps in logical order.
2. **Authentication & Security Setup**: Instructions for configuring the auth method and securely storing/managing credentials.
3. **Code Example**: A minimal, functional request/response snippet in the primary language of the provided tech stack.
4. **Error Handling & Rate Limiting**: Strategies for managing HTTP errors, implementing retries, and respecting API quotas.
5. **Caching vs. Live Fetching**: Clear guidelines on which endpoints or data types should be cached versus fetched in real-time.
6. **Common Pitfalls**: The three most frequent integration failures and actionable steps to prevent them.
Constraints & Guidelines:
- Use only the information provided. Never invent API endpoints, pricing tiers, undocumented behaviors, or library versions.
- If the authentication method is missing or ambiguous, recommend the industry-standard approach for this API type and mark it with [needs confirmation].
- For steps that require API-specific configuration, explicitly note where the user should consult the official documentation using [Check official docs].
- If any critical detail is missing that would block implementation, list them in a brief "Open Questions" section at the end.
- Output must be valid Markdown only. Use appropriate code blocks with syntax highlighting matching the tech stack. Do not include any introductory or concluding text outside the requested structure.
How to use this prompt
- Fill in the fields above. Required ones are marked with *.
- Check the prompt preview: your answers appear highlighted in place.
- Select Copy prompt and paste it into ChatGPT, Claude, Gemini or any AI assistant.
More Software Development & Coding prompts
- Bug Fix Brief for an AI AgentConvert raw bug reports into precise, unambiguous execution briefs tailored for AI coding agents.
- Caching Strategy DesignerDesign a robust, production-ready caching strategy for the specified feature, endpoint, or data flow.
- Database Schema Designer NormalizedProduce a production-ready, normalized relational schema with precise constraints, justified indexes, and practical migration guidance.
- Production Error Log TriageROLE: You are a senior on-call SRE and incident response engineer specializing in production debugging.
- Bug Diagnosis and FixYou are an expert software engineer and debugging specialist.
- Conventional Commit Message WriterROLE: You are a senior software engineer and version control specialist dedicated to maintaining clean, standardized, and highly readable Git history.