AIO APEX
Claude Sonnet 4.6 or GPT-5A backend developer is wiring up a new payment provider integration before a Monday demo. She has the API docs open but needs to make sure she is not missing the error handling edge cases or webhook verification details that will cause production incidents later.Developer Tools

مواصفات تكامل API: حوّل أي API لطرف ثالث إلى خطة تنفيذ جاهزة للإنتاج

مشاركة:
مواصفات تكامل API: حوّل أي API لطرف ثالث إلى خطة تنفيذ جاهزة للإنتاج

لماذا تهم هذه المطالبة

Most API integration failures are not caused by calling the wrong endpoint — they happen because of unhandled error codes, missing retry logic, incorrect webhook signature verification, or silent rate-limit failures discovered only in production. A post-incident analysis of these bugs costs 10-50x more than preventing them. This prompt surfaces the integration gotchas upfront — the knowledge that normally requires either a painful incident or a colleague who has already burned their hand on this specific API.

فيم نستخدمها

A backend developer is wiring up a new payment provider integration before a Monday demo. She has the API docs open but needs to make sure she is not missing the error handling edge cases or webhook verification details that will cause production incidents later.

المطالبة

Act as a senior software engineer with extensive experience integrating third-party APIs into production systems. You specialize in identifying edge cases, failure modes, and the "gotchas" that developers only discover after a painful production incident.

API to integrate: [API NAME, e.g., Stripe Payments, Twilio SMS, Salesforce, SendGrid]
My application: [DESCRIBE YOUR APP IN 1-2 SENTENCES]
What I need to do: [DESCRIBE THE SPECIFIC FUNCTIONALITY, e.g., "Process one-time payments and store customer payment methods for recurring billing"]
Tech stack: [LANGUAGE/FRAMEWORK, e.g., Node.js + Express, Python + Django, Go + Gin]
Known constraints: [ANY KNOWN LIMITS, e.g., "We are on the free tier", "Must be GDPR compliant", or "none"]

Generate a complete API integration spec with the following sections:

1. AUTHENTICATION SETUP
   - How authentication works for this API (API keys, OAuth 2.0, JWT, mTLS, etc.)
   - Where and how to store credentials securely in [TECH STACK]
   - Token refresh logic if required, including expiry handling

2. CORE IMPLEMENTATION PLAN
   - The exact sequence of API calls needed to fulfill [WHAT I NEED TO DO]
   - Required vs. optional parameters for each call
   - The shape of the request payload and what a successful response looks like
   - Any stateful dependencies between calls (e.g., must create customer before charging)

3. ERROR HANDLING MAP
   - The most common error codes this API returns and their root causes
   - Which errors are safe to retry vs. which are fatal and require user action
   - Recommended retry strategy: backoff timing, max attempts, jitter
   - How to surface errors to the user vs. handle silently

4. RATE LIMITS & QUOTAS
   - Request limits per second, minute, and day
   - How to detect when you are approaching limits (headers, error codes)
   - Recommended approach for high-volume usage (queuing, batching, caching)

5. WEBHOOKS & ASYNC EVENTS (if applicable)
   - What events this API delivers via webhook and their payload structure
   - How to verify webhook signatures to prevent spoofing
   - Idempotency: how to handle duplicate webhook deliveries safely

6. PRE-LAUNCH TESTING CHECKLIST
   - How to test this integration in sandbox or test mode without real data
   - The 5 most critical edge cases to validate before going to production
   - What metrics to monitor after launch (latency p95, error rate, success rate)

Constraints:
- Be specific to [API NAME]. Use real endpoint names, real error codes, and real response field names where known.
- Explicitly flag anything that commonly trips up developers integrating this API for the first time.
- If there are known quirks, undocumented behaviors, or common pitfalls with this API, mention them explicitly.

النتيجة

API Integration Spec: Stripe Payments API
Application: SaaS subscription platform (Node.js + Express)
Goal: Process one-time payments and store payment methods for monthly recurring billing

1. Authentication Setup

  • Stripe uses separate secret and publishable API keys. Secret key (sk_live_...) stays server-side only — never exposed to the browser. Publishable key (pk_live_...) is safe for the frontend.
  • Store STRIPE_SECRET_KEY and STRIPE_WEBHOOK_SECRET in environment variables, never in source code. In Node.js: process.env.STRIPE_SECRET_KEY.
  • No token refresh needed — Stripe API keys do not expire. Rotate them via the Stripe Dashboard if compromised.

2. Core Implementation Plan

  • Step 1 — Create a Customer: POST /v1/customers with email and metadata. Store the returned customer.id in your database. This must happen before charging.
  • Step 2 — Collect payment method securely: Use Stripe.js on the frontend to tokenize card details. Your server never sees raw card numbers. The frontend returns a paymentMethod.id.
  • Step 3 — Create a PaymentIntent: POST /v1/payment_intents with amount (in cents), currency, customer, and payment_method. Set confirm: true to charge immediately.
  • Step 4 — Attach payment method for recurring billing: After first successful payment, call POST /v1/payment_methods/:id/attach with customer ID. Set as default: POST /v1/customers/:id with invoice_settings.default_payment_method.

3. Error Handling Map

  • card_declined — Card issuer rejected. Fatal; show user a human-readable message. Do NOT retry.
  • insufficient_funds — Fatal for this attempt. Prompt user to use a different card.
  • rate_limit (HTTP 429) — Safe to retry with exponential backoff: 1s, 2s, 4s, max 3 attempts.
  • idempotency_key_in_use — You sent the same idempotency key for a different request body. Use a new UUID.
  • Network timeout — Always use idempotency keys on POST requests so retries are safe. Check PaymentIntent status before retrying to avoid double charges.

4. Rate Limits

  • Default: 100 read requests/second, 100 write requests/second per account.
  • Approaching limits: Stripe returns X-RateLimit-Remaining and X-RateLimit-Reset headers. Watch for HTTP 429.
  • For high volume: use idempotency keys and consider Stripe's batch API for bulk operations.

5. Webhooks

  • Critical events to handle: payment_intent.succeeded, payment_intent.payment_failed, invoice.payment_failed (for subscriptions), customer.subscription.deleted.
  • Always verify the webhook signature: stripe.webhooks.constructEvent(payload, sig, process.env.STRIPE_WEBHOOK_SECRET). Reject any webhook that fails verification — forged webhooks are a real attack vector.
  • Make all webhook handlers idempotent. Stripe may deliver the same event twice. Use the event id to deduplicate.

6. Pre-Launch Testing Checklist

  • Use test card 4242 4242 4242 4242 for successful charges; 4000 0000 0000 9995 to simulate insufficient funds.
  • Test cases: successful charge → subscription creation → card decline → webhook delivery → duplicate webhook (send same event twice via Stripe Dashboard).
  • Monitor in production: payment success rate (alert if drops below 95%), PaymentIntent creation latency p95, webhook processing latency, and payment_intent.payment_failed rate by failure reason.

First-time Stripe gotcha: If you confirm a PaymentIntent server-side and the charge requires 3D Secure authentication, you will get a requires_action status instead of succeeded. Your frontend must handle this with stripe.handleNextAction(). Most developers hit this only when testing with European test cards.

نادرًا ما تكون مشكلة دمج API لطرف ثالث لأول مرة هي المشكلة الفعلية. المشكلة هي كل ما يحدث بعد ذلك: استجابة حد المعدل التي نسيت معالجتها، فحص توقيع webhook الذي تخطيته، الحالة الحدية حيث يؤدي انتهاء مهلة الشبكة إلى تركك غير متأكد مما إذا كانت الدفعة قد تمت معالجتها. الأخطاء التي تسبب حوادث الإنتاج ليست أبدًا تقريبًا "لقد استدعيت نقطة النهاية الخاطئة" — بل هي "لم أكن أعرف رمز الخطأ هذا" أو "افترضت أن webhook سيصل مرة واحدة بالضبط".

يُنتج هذا المطوّر مواصفات تكامل كاملة قبل أن تكتب سطرًا واحدًا من الكود. يكشف عن رموز الخطأ، ومنطق إعادة المحاولة، والمشكلات المخفية في webhook التي عادةً ما تتعلمها فقط من الخبرة أو مراجعة ما بعد الحادث.

ما ينتجه المطوّر

الناتج هو مواصفات تكامل منظمة في ستة أقسام تغطي إعداد المصادقة، تسلسل الاستدعاء الدقيق الذي تتطلبه حالة الاستخدام الخاصة بك، خريطة معالجة الأخطاء حسب رمز الخطأ، تفاصيل حدود المعدل، التحقق من توقيع webhook، وقائمة اختبار ما قبل الإطلاق لأكثر خمس حالات حدية عرضة للتسبب في حوادث الإنتاج.

القيود الرئيسية المضمنة في المطوّر هي التحديد: فهو يطلب صراحةً أسماء نقاط نهاية حقيقية، ورموز خطأ حقيقية، وأسماء حقول استجابة حقيقية — وليس نصائح تكامل API عامة. بالنسبة لواجهات API المستخدمة على نطاق واسع مثل Stripe وTwilio وSalesforce وSendGrid وSlack وGitHub، تمتلك النماذج الحالية بيانات تدريب كافية لإنتاج مخرجات مفيدة حقًا ومخصصة لواجهة API. بالنسبة لواجهات API الأقل شيوعًا، قم بلصق وصف لآلية المصادقة ونقطتي نهاية رئيسيتين، وسيقوم النموذج بملء الباقي من السياق.

متى تستخدمه

قم بتشغيل هذا المطوّر قبل البدء في أي تكامل API جديد — وليس بعد أن تكون قد كتبت بالفعل المسار السعيد. الهدف هو تعلم متطلبات معالجة الأخطاء قبل أن تتحول إلى جلسات تصحيح. إنه مفيد بشكل خاص لواجهات API ذات تدفقات المصادقة المعقدة (OAuth 2.0 مع refresh tokens، mTLS)، وواجهات API التي تقدم نتائج غير متزامنة عبر webhook، وواجهات API ذات متطلبات عدم التكرار غير الواضحة.

كيف تخصصه

الحقول الخمسة بين قوسين في الأعلى تقود كل شيء. كلما كان حقل "ما أحتاج إلى فعله" أكثر تحديدًا، كلما كان تسلسل الاستدعاء أكثر استهدافًا. إذا كنت تقوم بدمج API أقل شيوعًا، أضف ملاحظة في "القيود المعروفة" مع أي أسماء نقاط نهاية أو تفاصيل مصادقة تعرفها بالفعل — فهذا يحسن بشكل كبير من تحديد المخرجات.

بالنسبة للفرق التي تقوم بأعمال تكامل منتظمة، احفظ المخرجات كملف مواصفات Markdown بجانب كود التكامل. يصبح هذا وثائق مفيدة وقائمة مراجعة لمراجعة الكود.

developer toolsai-promptscodingbackendapi-integration
مشاركة: