רשימת בדיקות אינטגרציה של API

0) סקירה מהירה (מי עושה מה)

[ ] שבעל אינטגרציה מוקצה

[ ] אנשי קשר בכוננות (24 × 7/שעות עבודה)

[ ] מוסכם SLO/SLA ולשחרר חלון תמיכה

[ דף סטטוס ] וערוץ תקרית (דוא "ל/רפוי/webhook)

1) נגישות, סביבות, גרסאות

[ ] ארגז חול/היערכות/הפקה לגשת

גרסת API [ ] אישרה: "/v1 '/hader 'X-API-Version &pos

[ ] לאפשר הגדרות כללי IP ורשת

[ שעון ] וט "ז: כל הפעמים ב-UTC, סינכרון NTP

[ ] SEMVER SDK/לקוח תאימות ומטריצות גרסה מאומתות

2) אימות ואסימונים

מנגנון [ ] הסכים OAuth2 לקוח/Auth Code + PKCE/API Key/mTLS

[ ] גישה לכל החיים רענון וסיבוב טוקן מוגדר

[ ] עבור מפתח API: הסוד מוצג פעם אחת, מאוחסן במנהל הסודי

[ ] JWKS/JTI/” ילד ”בדוק, שעון רזה על nine 5 min

[ כותרות ] 'אישור' לא נרשם (revision)

שיחת מבחן:

bash curl -sS -H "Authorization: Bearer $TOKEN" https://api. example. com/v1/ping

3) ביטחון ופרטיות

[ ] TLS 1. 2 +/HSTS, mTLS אופציונלי

[ ] מזעור מח "ש: אנחנו שולחים רק מה שאנחנו צריכים, מסכות ביומנים

[ מדיניות השימור ] (GDPR/DSAR) מתועדת

[ סיבוב ] סודי: מפתח פעיל/הבא, תכנית גלגול

[ ] נגד התעללות: Captcha/Keying Speed/Registration

4) גבולות, מכסות וחזרה

[ ] הכריזו על ”X-Ebusit- ”/” X-Quota-” כותרות

לקוח [ ] מכבד את 429 ו- "Retry-After &fos

[ ] מגשים מחדש עבור 5xx/408/429 בלבד, גיבוי מעריכי + jitter

[ ] Retry/Time retral set (לדוגמה 5 retrelies, 60C בסך הכל)

5) אידמפוטנטיות וקונפליקטים

[ ] כל פעולות הכתיבה נשלחות עם 'Idempotency-Key' (TTL-im-24-72 h)

[ ] לשכפל סכסוכים * 409 IDEMP_REPLAY

[ ] ETag/' IF-Match 'מאופשר לעדכונים תחרותיים (אם זמינים)

דוגמה:

bash curl -X POST /v1/payments \
-H "Idempotency-Key: pay-<uuid>" \
-d '{"amount":"12. 34","currency":"EUR"}'

6) פגינציה ודלתא אינקרמנטלית

[ ] הסמן/keyset pagination בשימוש (”הבא _ הסמן”, ”יש _ more”)

[ ] סוג יציב ”(updated_at, id)” מתועד

[ ] העלאות מצטברות: סימן מים או שינוי אסימון

[ ] חופפים (חפיפה של 1-2 דקות) ו-dedup by '(id, גרסה/seq) "

7) תבנית שגיאה ואבחון

[ תבנית אחידה ] ”יישום/בעיה + json” (RFC 7807)

[ ] תמיכה בשדה: ”שגיאה _ קוד”, ”trace _ id',” retriable ”,” detaille &fost

[ ] שגיאה במפה ופעולות הלקוח שתוארו (runbook)

תבנית:

json
{
"type":"https://docs. example. com/errors/validation_failed",
"title":"Validation failed",
"status":422,
"error_code":"VAL_001",
"trace_id":"a1b2c3",
"retriable":false
}

8) אינטרנט: הכרה והילוך חוזר

[ ] אישור להצלחה - כל 2xx; ACK מהיר לאחר חקירה

[ ] HMAC ('X-חתימה: Sha256 =...'), X-Webhook-ID, 'X-Retrypos

[ מדיניות ] ריטריי: גיבוי + ג 'יטר, עד 24-72 שעות

[ ] DLQ + שידור חוזר:

[ ] אחסון דדאפ במקלט, חלונות מגש מחדש TTL

9) יכולת תצפית ואיתור

[ ] הווי OpenTelemetry מאופשר בלקוח/SDK

[ ] עקבות רחבות שרשרת _ id/X-Request-ID

[ ]: "בקשות: סך הכל", "טעויות _ סך הכל", "latency _ p95", "retry _ count'," 429 _ rattefost "

[ ] אזעקות: 5xx/429 spike, p95 rise, ירידה בקצב ההצלחה, webhook lag

PromQL (דוגמה):

promql rate(http_requests_total{status=~"5.."}[5m]) / rate(http_requests_total[5m])

10) ביצועים ויציבות

[ ] בריכות חיבור, לשמור בחיים, HTTP/2/3 היכן שאפשר

[ ] תור הלקוח אינו ”מנופח”

[ ] מדיניות מפסק מעגל/פסק זמן/נפילה מוגדרת

[ ] בדיקות עומס: פרץ 10 ×, חיבורים ארוכים, התחלה קרה

11) נתונים, מטבעות, זמן

[ ] פורמטים: ISO-8601 UTC, כסף - מחרוזות עשרוניות/יחידות שוליות,

[ ] קישוטים/שפות עקביים (למשל: ”קבל-שפה” עבור הודעות אבל ”שגיאה _ קוד” עבור מכונה)

[ ] מדיניות עיגול/עמלה מתועדת

12) פיוס

[ ] פיוס יומי/שעתי עם צ 'מסומים

[ ] API/מעלה לפיוס שנבדק (CSV/JSON, מניפסטים/חשיש)

[ ] אי התאמות - בכרטיסים עם אזכורים ל "עקבות _ idofost

13) ציות והיבטים משפטיים

[ ] תנאי השימוש של API המקובלים (שימוש הוגן/בקרת יצוא)

[ ] PII/Data Holders - תפקידים ואזורי אחסון מוגדרים

[ יומן ]/יומן ביקורת משפטי פעולות אפשרו לתקריות

14) תיעוד ופורטל מפתח

[ ] OpenAPI/ASyncAPI רלוונטיים, ישנן דוגמאות של ”העתק-הדבק”

[ ] SDK (TS/Py/Java/Go/NET) - גרסאות עקביות, ספר בישול זמין

[ ] מגרש המשחקים עובד, מפתחות החול פעילים

[ ] Changelog/productions/road map גלויים בפורטל

15) בדיקה: תפקודי, שלילי, כאוס

פונקציונלי

[ ] תרחישי CROD/key עבר (דרך שמחה)

[ ] Pagination/Corsor/Incremental Deltas

שלילי

[ ] 401/403/404/409/422/429/5xx ו ”Retry-After” עיבוד

[ ] חתימת webhook שגויה, אסימונים שפג תוקפם, גופים גדולים

כאוס

[ ] טיפה 10-30% אירועים, סדר מחדש, 1-10 דקות עיכובים

[ ] תלות ניתנת לנטרול (PSP/KYC) ‏

16) קבלה ושיגור (ללכת-לחיות)

[ ] הסופית (Review Production Review) עברה

[ הכללת ] הקנרית: 10% -25% -05% -100%

[ ] אוטומטית על אותות SLO (שגיאות/latency/429)

[ ] מטריקס מגע תקרית ונתיב הסלמה פורסם

[ ] CAPA אחרי הטייס שנוצר

17) מבצע ותמיכה

[ ] Runbook/playbooks: "5xx spike", "429 storm", "webhook backlog", "timeout'

[ ] דוחות תקציב סדירים של SLO/שגיאות

[ ] סודות מסתובבים ומפתחות בלוח זמנים

[ ] תוכנית דיפרסיה/תוכנית הגירה הסכימה (תאריך שקיעה)

18) תבניות חפץ

תבנית הגדרות env

yaml api:
base_url: https://api. example. com/v1 timeout_ms: 10000 retries: { max: 5, strategy: expo-jitter }
auth:
kind: oauth2 token_url: https://auth. example. com/oauth2/token scopes: [wallet:read, wallet:write]
webhooks:
secret_ref: secret/webhook-hmac parallelism: 10 max_body_kb: 256

מדיניות מגש (פסאודו)

json
{"initial":1,"max":60,"factor":2. 0,"jitter":0. 2,"retriable":["5xx","408","429"]}

19) רשימה אחרונה ”לחתימה”

[ ] סביבות/גרסאות/מפתחות/רשימת מקשים

[ ] Auth/JWT/keys/mTLS הוגדר ונבדק

[ ] גבולות/מכסות/מגשים/אידמפוטנטיות מיושמת

[ ] הפגינציה/הסמן/דלתא לעבוד על נתונים

[ ] Webhooks: חתימות, הילוכים חוזרים, DLQ/שידור חוזר מאומת

[ שגיאות ] "בעיה + json", "עקבות _ id' sticks לכל היומנים

[ ] לוחות מחוונים/התראות שנאספו, אוטל התאפשרה

[ ] בדיקות עומס/שלילי/כאוס עברו

[ ] ההתפייסות והדו "חות מתכנסים, ספרי הריצה הם פורמליים

[ ] PRR/Canary/rollback-תוכנית מוכנה, אנשי קשר בכוננות הצביע

סך הכל

רשימה זו עוסקת בהיבטים הטכניים, התפעוליים והצייתניים של שילוב API. עבור דרך פריטים מלמעלה למטה, בדיקת גבולות אוטומטית, אידמפוטנטיות וספרי אינטרנט, אפשר תצפית ותוכנית החלפה - וההשקה שלך תהיה צפויה, ללא ”הפתעות” בייצור.

רשימת בדיקות אינטגרציה של API

שלילי

כאוס

מדיניות מגש (פסאודו)

סך הכל

צרו קשר

חיבור מהיר

הווידאו יעודכן בקרוב

אנחנו עמוסים מאוד בפרויקטים כרגע