אימות

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

אימות באמצעות מפתח API

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

איך זה עובד

1. אתם משיגים מפתח API מעמוד מפתחות ה-API של Felo API Platform
2. אתם כוללים את מפתח ה-API בכותרת Authorization של כל בקשת API
3. הפלטפורמה מאמתת את מפתח ה-API שלכם ומעבדת את הבקשה

פורמט הכותרת

כללו את מפתח ה-API בכותרת Authorization באמצעות סכמת האימות Bearer:

Authorization: Bearer YOUR_API_KEY

דוגמת בקשה

curl -X POST https://openapi.felo.ai/v2/chat \
  -H "Authorization: Bearer sk_live_abc123xyz789" \
  -H "Content-Type: application/json" \
  -d '{"query": "What is machine learning?"}'

השגת מפתח ה-API

כדי להשיג את מפתח ה-API:

1. פתחו את עמוד מפתחות ה-API של Felo API Platform
2. התחברו עם חשבון Felo אם מתבקשים
3. הזינו שם מפתח ולחצו על Create Key
4. העתיקו את המפתח המלא כשהוא מופיע. הוא מוצג פעם אחת בלבד
5. אחסנו את המפתח באופן בטוח והשתמשו בו כ-FELO_API_KEY

שיטות עבודה מומלצות לאבטחה

1. אחסון מפתחות API באופן בטוח

אל תקבעו מפתחות API בקוד המקור שלכם:

# ❌ Bad - API Key exposed in code
api_key = "sk_live_abc123xyz789"

כן השתמשו במשתני סביבה או בתצורה מאובטחת:

# ✅ Good - API Key from environment
import os
api_key = os.environ.get('FELO_API_KEY')

2. שימוש במשתני סביבה

אחסנו את מפתח ה-API שלכם במשתני סביבה:

Linux/macOS:

export FELO_API_KEY="sk_live_abc123xyz789"

Windows (Command Prompt):

set FELO_API_KEY=sk_live_abc123xyz789

Windows (PowerShell):

$env:FELO_API_KEY="sk_live_abc123xyz789"

3. החלפת מפתחות באופן קבוע

צרו מפתחות API חדשים ובטלו ישנים מעת לעת כדי למזער סיכוני אבטחה.

4. שימוש במפתחות שונים עבור סביבות שונות

צרו מפתחות API נפרדים עבור סביבות פיתוח, בדיקה וייצור.

5. לעולם אל תחשפו מפתחות בקוד צד לקוח

יש להשתמש במפתחות API רק בקוד צד שרת. לעולם אל תכללו אותם ב:

• קוד JavaScript בצד הלקוח
• קוד המקור של אפליקציית מובייל
• מאגרים ציבוריים
• קבצי תצורה בצד הלקוח

שגיאות אימות

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

קודי שגיאה נפוצים

בקשה שנדחתה מחזירה את מצב המפתח ב-message:

{
  "status": 401,
  "code": "UNAUTHORIZED",
  "message": "API Key is required",
  "request_id": "..."
}

status הוא קוד סטטוס ה-HTTP. מפתח שבוטל מדווח API Key has been revoked (keyPrefix=...). הסתעפו לפי סטטוס ה-HTTP ו-code, ולא לפי הנוסח המדויק של message.

פתרון בעיות

אם האימות נכשל:

1. בדקו שהכותרת היא בדיוק Authorization: Bearer YOUR_API_KEY.
2. ודאו שהמפתח לא בוטל בעמוד מפתחות ה-API.
3. ודאו שהסביבה משתמשת במפתח שאתם מצפים לו.
4. צרו מפתח חדש אם המפתח הישן נמחק או הוחלף. מפתח מלא מוצג פעם אחת בלבד, בעת היצירה.

עבור רשימת בדיקה שמתחילה מהתסמין ומכסה אימות ואת שאר הפלטפורמה, ראו פתרון בעיות.

דוגמה: איתור בעיות אימות

import requests

url = "https://openapi.felo.ai/v2/chat"
api_key = "YOUR_API_KEY"

# Correct format
headers = {
    "Authorization": f"Bearer {api_key}",
    "Content-Type": "application/json"
}

response = requests.post(url, headers=headers, json={"query": "test"})

if response.status_code == 401:
    error = response.json()
    print(f"Authentication failed: {error['code']}")
    print(f"Message: {error['message']}")
    print(f"Request ID: {error['request_id']}")
else:
    print("Authentication successful!")

מגבלת קצב

מגבלות קצב נאכפות לפי endpoint, ולא באופן גלובלי לפי מפתח API. נכון להיום רק `/v2/chat` אוכף אותן; משתמשים עם מינוי Felo בתשלום בתוקף פטורים. לנקודות קצה אחרות של /v2/** אין מגבלות קצב נאכפות.

תגובת 429 כוללת כותרות X-RateLimit-* ו-Retry-After. תמיד קראו את המגבלות האפקטיביות מכותרות התגובה, ולא מהתיעוד.

עבור ממדי מגבלת הקצב המלאים, הכותרות ומדיניות הניסיונות החוזרים, ראו שגיאות, מגבלות וניסיונות חוזרים.

צריכים עזרה?

אם אתם נתקלים בבעיות אימות:

1. עברו על המדריך הזה בעיון
2. בדקו את מדריך התחלה מהירה
3. אמתו את מפתח ה-API שלכם בעמוד מפתחות ה-API
4. צרו קשר עם התמיכה בכתובת [email protected] וצרפו את מזהה הבקשה שלכם

הצעדים הבאים

• מדריך התחלה מהירה - למדו כיצד לבצע את קריאת ה-API הראשונה שלכם
• מסמכי Chat API - עיינו בתיעוד Chat API