תיעוד API

התחלה מהירה

curl -X POST http://localhost:5000/api/v1/surveys/recipients \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "recipients": [
      {
        "name": "יוסי כהן",
        "phone": "+972501234567"
      }
    ],
    "interaction_type": "AI-25-K8F3Q9A"
  }'

{
  "success": true,
  "campaignId": "AI-25-K8F3Q9A",
  "recipientsAdded": 1,
  "recipientsRejected": 0,
  "scheduledFor": "immediate"
}

אימות

כל הבקשות ל-API דורשות אימות באמצעות API Key שמועבר בכותרת הבקשה:

x-api-key: YOUR_API_KEY_HERE

API Endpoint

http://localhost:5000/api

POST /v1/surveys/recipients

פורמט הבקשה

{
  "recipients": [
    {
      "name": "יוסי כהן",
      "phone": "+972501234567",
      "branch": "תל אביב",
      "metadata": {
        "agent": "משה לוי",
        "order_id": "ORD-12345"
      }
    },
    {
      "name": "שרה לוי",
      "phone": "+972509876543",
      "branch": "חיפה",
      "metadata": {
        "agent": "דנה כהן",
        "department": "מכירות"
      }
    }
  ],
  "interaction_type": "AI-25-K8F3Q9A",
  "scheduling": {
    "type": "immediate"
  }
}

פורמט התשובה

{
  "success": true,
  "campaignId": "AI-25-K8F3Q9A",
  "recipientsAdded": 150,
  "recipientsRejected": 0,
  "scheduledFor": "immediate"
}

דוגמאות קוד

דוגמאות מעשיות לשימוש ב-API בשפות תכנות שונות:

curl -X POST http://localhost:5000/api/v1/surveys/recipients \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "recipients": [
      {
        "name": "יוסי כהן",
        "phone": "+972501234567"
      }
    ],
    "interaction_type": "AI-25-K8F3Q9A"
  }'

טיפול בשגיאות

ה-API מחזיר קודי שגיאה סטנדרטיים של HTTP. להלן השגיאות הנפוצות ופתרונן:

Best Practices

• שליחה מקובצת (Batching)

  עבדו עם 50-100 נמענים בבקשה אחת למען ביצועים מיטביים ולמניעת עומס מיותר.

• בדיקת פורמט טלפון

  וודאו שמספרי הטלפון בפורמט בינלאומי תקין (+972...) לפני השליחה.

• טיפול בשגיאות ו-Retry Logic

  יישמו מנגנון retry עם exponential backoff למצבי שגיאה זמניים (500, 429).

• מעקב אחר recipientsAdded vs recipientsRejected

  בדקו את התשובה כדי לזהות נמענים שנדחו ולטפל בהם בהתאם.

• אבטחת API Key

  שמרו את המפתח כ-environment variable, אל תכללו אותו בקוד או במאגר הווירסיה.

שאלות נפוצות