מפתחות API
בדף זה
מפתחות API מאפשרים לתוכנה שלכם — או לכל מערכת צד שלישי שתומכת ב-BYOK (Bring Your Own Key) — להשתמש במודלים ש-Performance Hub מפרסם. המפתחות מנוהלים תחת Settings (גלגל השיניים) ← Service Access & API Keys. כדי לנהל אותם צריך להיות Organisation Administrator.
"הקצו מפתחות API כך שתוכנות ומערכות צד שלישי התומכות ב-BYOK (Bring Your Own Key) יוכלו להתחבר למודלים שפורסמו על ידי Performance Hub."
איור 1: רשימת מפתחות ה-API: תווית, מפתח ממוסך, סטטוס, הוצאה ומגבלות, מודלים, שימוש אחרון ופעולות השורה
רשימת המפתחות
| עמודה | משמעות |
|---|---|
| Label | השם האופציונלי שנתתם למפתח. |
| Key | המפתח הממוסך (לדוגמה phk_7Qm2…Xa9LkP) — הסוד המלא לא מוצג שוב לאחר היצירה. |
| Status | Active, Provisioning… (לזמן קצר, בזמן שמפתח חדש מוגדר) או Disabled (נשלל; השורה מעומעמת). |
| Spend / limits | ההוצאה לכל התקופה וההתקדמות לעבר מגבלות הוצאה שהוגדרו למפתח. |
| Models | all, או מספר המודלים שהמפתח מוגבל אליהם. |
| Last used | מתי המפתח ביצע בקשה לאחרונה. |
| Actions | Edit, Rotate, Revoke (או Re-activate), Delete. |
אם אתם משתמשים ב-Workflows, שורת Workflows מציגה Managed service במקום מפתח ממוסך. כשאין מפתחות כלל, הרשימה מציגה "No API keys yet."
יצירת מפתח
לחצו על Create key. המגירה Create API key נפתחת:
איור 2: המגירה Create API key: תווית, סוג חיבור, מגבלות הוצאה, מגבלות קצב, הגבלת מודלים ועקיפת Guardrails
| הגדרה | התנהגות |
|---|---|
| Label (optional) | שם למפתח, בדרך כלל המערכת שהוא מיועד לה (לדוגמה Hotel Concierge App, Clinic Intake Assistant או Booking Website). מומלץ מאוד — לפי התוויות השימוש משויך ב-Activity וב-Logs. |
| Connection type | API key — "Generic API keys remain in the API Keys list." External agent — "External agents appear under Connected Services and use this key to authenticate." נקבע בעת יצירת המפתח; אי אפשר לשנות אותו מאוחר יותר. |
| Set spend limits for this key | "Set any combination of daily, monthly and lifetime caps for this key." — Daily limit ("Resets at the start of each day (facility timezone)."), Monthly limit ("Resets on the 1st of each month (facility timezone).") ו-Lifetime cap ("Total spend over the lifetime of this key. Never resets."). |
| Rate limits (optional) | "Cap requests and tokens per minute for this key. Leave blank for unlimited." — Requests / min ו-Tokens / min. |
| Restrict models for this key | "Only the selected models will be usable with this key." בחרו מתוך המודלים המופעלים במתקן. |
| Override facility guardrails for this key | "Select none to explicitly disable guardrails for this key." כשהאפשרות פעילה, המפתח הזה משתמש בבחירת Guardrails משלו במקום זו של המתקן — כולל "ללא". ראו Guardrails. |
לחצו על Create key.
הסוד החד-פעמי
המפתח החדש מוצג פעם אחת, בתיבת הדו-שיח Copy your API key:
איור 3: המפתח החדש מוצג פעם אחת: העתיקו אותו לפני שתסגרו את תיבת הדו-שיח
"זו הפעם היחידה שבה המפתח המלא מוצג. שמרו אותו במקום בטוח."
העתיקו אותו למנהל הסודות שלכם לפני שתלחצו על Done. לאחר שתיבת הדו-שיח נסגרת, מוצגת רק הצורה הממוסכת. אם איבדתם את הסוד, בצעו Rotate למפתח כדי לקבל סוד חדש.
עריכת מפתח
לחצו על השורה של מפתח (או על סמל העיפרון Edit שלו) כדי לפתוח את המגירה Configure API key — אותן הגדרות כמו ביצירה (תווית, מגבלות הוצאה, מגבלות קצב, הגבלת מודלים, עקיפת Guardrails):
איור 4: המגירה Configure API key
השינויים נכנסים לתוקף תוך רגעים מהשמירה. כשלמפתח יש מגבלות יומיות/חודשיות, השורה שלו מציגה את השימוש ביחס אליהן (Today, This month, Lifetime) ותג Limit reached כשמגיעים לאחת מהן.
מחזור החיים של מפתח: החלפה, שלילה, מחיקה
לכל פעולה יש תיבת דו-שיח לאישור שמתארת בדיוק מה יקרה:
| פעולה | השפעה | טקסט האישור |
|---|---|---|
| Rotate | מנפיקה סוד חדש (מוצג פעם אחת) עם אותן הגדרות; הסוד הישן מפסיק לעבוד מיד. | "A new key will be issued and the current key will stop working immediately." "You will need to reconfigure any services still using the old key. This cannot be undone." |
| Revoke | משביתה את המפתח מיד, באופן הפיך. | "This key will be disabled immediately and any services using it will stop working. You can re-activate it again later." |
| Re-activate | משחזרת מפתח שנשלל (אותו סוד). | אין — מתבצעת מיד. |
| Delete | מסירה את המפתח לצמיתות. | "This permanently deletes the key and any services using it will stop working. This cannot be undone." |
איור 5: אישור Delete API key
במה להשתמש: החליפו (Rotate) כשיש חשד לדליפה (השירות שומר על ההגדרות וההיסטוריה שלו — רק מעדכנים את הסוד); שללו (Revoke) כדי להשהות מערכת באופן זמני; מחקו רק כשהשילוב הוסר לתמיד.
התחברות עם מפתח
הכרטיס Connecting to the API מתחת לרשימת המפתחות מציג את כתובת ה-URL הבסיסית ובקשת דוגמה להעתקה והדבקה עבור הסביבה שלכם. ראו חיבור האפליקציה שלכם למדריך המהיר המלא עם דוגמאות SDK וטיפול בשגיאות.