All templates/Development

API Integration Guide Writer

API integration guide with auth flows, code examples, pagination, webhooks, and production checklist.

developmentapiintegrationcoding
Edit View
Prompt
Write a guide for integrating with: {{api_name}}

API type: {{api_type}}
My stack: {{stack}}
Auth method: {{auth_method}}
Use case: {{use_case}}

Create:

1. **Setup**:
   - Account creation and API key generation steps
   - Required environment variables
   - Recommended SDK/library installation
   - Rate limits and quotas to be aware of

2. **Authentication**:
   - Complete auth flow code (copy-paste ready)
   - Token refresh handling
   - Error handling for auth failures
   - Security best practices (never hardcode keys, use env vars)

3. **Core operations** (for my use case):
   For each operation:
   - Endpoint, method, headers
   - Request body with all parameters explained
   - Full code example
   - Response parsing
   - Error handling for common failures

4. **Pagination handling**: How to fetch all results when paginated

5. **Webhook setup** (if applicable):
   - How to receive webhooks
   - Signature verification
   - Retry handling

6. **Production checklist**:
   - [ ] Rate limiting/throttling implemented
   - [ ] Retry logic with exponential backoff
   - [ ] Error logging and monitoring
   - [ ] API key rotation strategy
   - [ ] Graceful degradation if API is down

Save this prompt to your library

Organize, version, and access your best prompts across ChatGPT, Claude, and Cursor.