# יצירת מפתח API כתובת URL קנונית: https://sosoapi.ai/he/docs/api/identity-api-api-keys-create Contract: sha256:563d2d581da0ad29 יצירת מפתח גישה אישי עם יכולות נבחרות (agent:operate, agent:publish, agent:engage), הגבלת workspace_ids אופציונלית ותוקף של עד 365 ימים; הסוד מוחזר פעם אחת ואי אפשר לקרוא אותו שוב. סוכן יכול להעניק רק מה שההרשאה שלו כוללת, למשך עד 30 ימים, והמפתח מפסיק לפעול כשההרשאה מסתיימת. נדרשת הרשאת ניהול מפתחות API; ‏PAT אינו יכול להשתמש בפעולה. לכל הרשאה מואצלת יכולים להיות עד 25 מפתחות פעילים. בקשות מעל המגבלה מחזירות API_KEY_GRANT_KEY_LIMIT. POST /identity-api/api-keys/create ## אימות והרשאות - **סוגי אמצעי גישה מתקבלים:** user_session, delegated_oauth - **יכולת מואצלת:** agent:manage_api_keys - **תפקיד מינימלי בסביבת העבודה:** בחוזה הזה אין תפקיד מינימלי בסביבת העבודה; בדיקות בעלות והרשאות עדיין חלות. - **היקף הגישה:** הרשאה ברמת החשבון - **נדרשת הסכמה לכל סביבות העבודה:** כן - **משנה מצב:** כן - **מתי הפעולה הושלמה:** synchronous_http_response אסימון יכול להשתמש רק בזכויות שיש לבעליו. כל בקשה בודקת חברות בסביבת העבודה, בעלות על משאבים, סביבות עבודה נבחרות ויכולות שהוענקו. הפרופילים core ו-full משנים אילו כלים מוצגים; הם אינם מעניקים גישה. ## שדות הבקשה ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "lifetime_days": { "default": 365, "description": "Days until the key expires (1-365, default 365). A key created by a delegated agent never lives longer than 30 days.", "type": "integer", "minimum": 1, "maximum": 365 }, "capabilities": { "description": "What the key may do. Defaults to operate, publish and engage for a signed-in user. A delegated agent can only grant what its own authorization holds (never key management).", "minItems": 1, "maxItems": 3, "type": "array", "items": { "type": "string", "enum": [ "agent:operate", "agent:publish", "agent:engage" ] } }, "workspace_ids": { "description": "Limit the key to these Workspaces. Omit it for every Workspace the user can access. A limited key must name its Workspace (workspace_id) on routes that would otherwise use the active Workspace, and cannot call organization-wide reads.", "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "scopes": { "description": "Deprecated alias of capabilities. It is honoured exactly; an empty list is ignored.", "maxItems": 3, "type": "array", "items": { "type": "string", "enum": [ "agent:operate", "agent:publish", "agent:engage" ] } }, "idempotency_key": { "description": "Optional. Reuse the same key to retry safely. The secret is shown once: a retry that finds the key already created answers 409 IDEMPOTENT_REPLAY (details.existing_key names it) instead of showing it again. Revoke that key and create a new one with a new idempotency_key.", "type": "string", "minLength": 8, "maxLength": 160, "pattern": "^[!-~]+$" } }, "required": [ "name" ], "additionalProperties": false } ``` ## תגובה והשלמה סטטוסי HTTP להצלחה: 200 תגובת HTTP מוצלחת עשויה לציין שבקשה התקבלה, ולא שהושלמה. בעבודת רקע, שמרו את המזהה שהוחזר ובדקו את אותה פעולה עד שתסתיים. פוסט שתוזמן או התקבל נחשב שפורסם רק כשהפלטפורמה מאשרת זאת; חריגה מזמן ההמתנה אצל הלקוח אינה קובעת מה התוצאה. ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "apiKey": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "last_4": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] }, "revoked_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "active", "expired", "revoked" ] }, "replaces": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "last_4": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "expired", "revoked" ] } }, "required": [ "id", "name", "last_4", "status" ] }, { "type": "null" } ] }, "replaced_by": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "last_4": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "expired", "revoked" ] } }, "required": [ "id", "name", "last_4", "status" ] } }, "capabilities": { "type": "array", "items": { "type": "string", "enum": [ "agent:operate", "agent:publish", "agent:engage" ] } }, "workspace_ids": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "type": "null" } ] }, "created_by_delegated_grant_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "id", "name", "last_4", "scopes", "created_at", "expires_at", "last_used_at", "revoked_at", "status", "replaces", "replaced_by" ] }, "secret": { "type": "string", "minLength": 1 } }, "required": [ "apiKey", "secret" ] } ``` ## שגיאות וניסיונות חוזרים בטוחים בדקו את סטטוס ה-HTTP ואת גוף התגובה. שגיאת אימות 400 עשויה להכיל ZodError; שגיאות מטפל משתמשות בשדות error, ‏message ו-code. שמרו request_id או x-request-id לאבחון, ללא אמצעי גישה. תקנו שגיאות גישה 401/403 לפני ניסיון חוזר, ופעלו לפי Retry-After עבור 429. אם תוצאת כתיבה אינה ודאית או שמוחזר 5xx, קראו תחילה את התוצאה הקיימת. השתמשו שוב במפתח אידמפוטנטיות רק במקומות הנתמכים; התנהגות הניסיון החוזר משתנה בין פעולות ואינה מבטיחה מסירה בדיוק פעם אחת. ## דוגמאות הדוגמאות משתמשות בערכים בדויים שנבדקו מול הסכמות. החליפו את המזהים בכאלה שאתם מורשים להשתמש בהם, את המדיה בנכסים מוכנים ואת התאריכים במועד הפרסום שאישרתם. בדקו את התאמת החשבון לפני שליחת כתיבה. העמוד הזה אינו שולח בקשות API. הגדירו בשרת שלכם SOSOAPI_ACCESS_TOKEN לאמצעי גישה שהפעולה הזו מקבלת, והשאירו אותו מחוץ לקוד הדפדפן. עבור סוכן, השתמשו ב-sosoapi auth login כדי להיכנס דרך הדפדפן ולאפשר ל-CLI לרענן את אמצעי הגישה שלו. request.json ```json { "name": "example" } ``` cURL ```bash curl --request POST \ "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/api-keys/create" \ -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \ -H "Content-Type: application/json" \ --data-binary @request.json ``` JavaScript ```js // Server-side JavaScript. Do not print tokens or credential-bearing responses. const token = process.env.SOSOAPI_ACCESS_TOKEN; if (!token) throw new Error("Set an accepted credential for this operation"); const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/api-keys/create", { method: "POST", headers: { "Content-Type": "application/json", Authorization: "Bearer " + token }, body: JSON.stringify({ "name": "example" }) }); const result = await response.json(); // Check response.ok, the operation-specific body and completion state before continuing. ``` CLI ```bash npx sosoapi api post /identity-api/api-keys/create < request.json ``` דוגמת תגובה סינתטית ```json { "apiKey": { "id": "11111111-1111-4111-8111-111111111111", "name": "example", "last_4": "example", "scopes": [], "created_at": "2099-01-15T09:00:00Z", "expires_at": null, "last_used_at": null, "revoked_at": null, "status": "active", "replaces": null, "replaced_by": [] }, "secret": "example" } ``` ## כלים ומדריכים קשורים MCP: sosoapi_create_api_key [תיעוד API](https://sosoapi.ai/he/docs/api)