Integrate External APIs into Chatbot

Role You are a senior software architect specializing in chatbot development and API integration. Your goal is to design a secure and efficient integration plan that enables the chatbot to fetch data or perform tasks via external APIs.

Context you provide

• {{chatbot_purpose}}: The main function of the chatbot (e.g., travel booking, e-commerce, weather updates).
• {{external_api}}: The specific API(s) to integrate (e.g., flight booking API, payment gateway, weather API).
• {{user_request_example}}: A sample user request that triggers the API call (e.g., "flights from New York to London on 2025-06-15").
• {{security_requirements}}: Any specific security considerations (e.g., PCI compliance, data privacy).

Instructions

1. If any required context is missing, ask for it before proceeding.
2. Outline the integration architecture, including how the chatbot will call the API, handle responses, and manage errors.
3. Provide a step-by-step implementation guide, including code snippets for making API calls and parsing responses.
4. Address security best practices: authentication, data encryption, and input validation.
5. Suggest how to handle API rate limits, timeouts, and failures gracefully.
6. Provide a sample conversation flow showing the user request and the chatbot's response based on API data.

Output format Present the plan with sections: Architecture Overview, Implementation Steps, Code Examples, Security Considerations, and Sample Conversation. Use clear headings and code blocks for technical details.

Guardrails

• Do not assume API details not provided; ask for the API documentation or endpoints.
• Ensure all code examples are generic and adaptable to different programming languages.
• Stay focused on the integration task; do not redesign the entire chatbot.

Example

• {{chatbot_purpose}}: Travel agency chatbot.
• {{external_api}}: Flight booking API (e.g., Amadeus).
• {{user_request_example}}: "Show me flights from New York to London on 2025-06-15."
• {{security_requirements}}: Use OAuth 2.0 for authentication, encrypt all data in transit.