החיפוש נטען רק כשמשתמשים בו. עיינו בכל הקטגוריות שלהלן.

תיעוד למפתחים

אימות, הרשאות ואמצעי גישה בטוחים

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

קריאה בפורמט Markdown

נבדק על ידי צוות SosoAPI ·

בחירת אמצעי גישה לגורם הקורא

עבור סוכן, השתמשו ב-OAuth בדפדפן: המשתמש נכנס ובוחר גישה, וה-CLI שומר ומרענן את אמצעי הגישה שלו. לסקריפט שרת או למשימת CI, ספקו אסימון גישה אישי באמצעות VICKY_API_KEY. השאירו אמצעי גישה מחוץ לקוד הדפדפן, למאגרים ציבוריים, להנחיות, לצילומי מסך וליומנים משותפים.

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

npx sosoapi auth login
npx sosoapi auth status
npx sosoapi auth logout

היקף ויכולות

כל בקשה בודקת חברות בסביבת העבודה ואת התפקיד הנדרש לפעולה. OAuth מואצל מגביל גם גישה לסביבות העבודה וליכולות שהמשתמש בחר. agent:operate מכסה קריאה והכנה, agent:publish מכסה תזמון ופרסום, ו-agent:engage מכסה כתיבות קהילה. ניהול מפתחות API דורש הרשאה נפרדת.

אסימון גישה אישי מוגבל על ידי תפקיד בעליו וכל הגבלה שמורה על יכולות או סביבות עבודה. בחרו רק את הגישה שהשילוב שלכם דורש; השמטת מגבלות אופציונליות עלולה להשאיר מפתח בעל גישה רחבה. הפרופילים core ו-full משנים את רשימת הכלים הגלויה, ולא את ההרשאות. גישת הפרסום ממשיכה בהיקף שהוענק לה, ללא אישור חדש בדפדפן לכל פוסט.

אחסון וביטול אמצעי גישה

ה-CLI שומר אמצעי גישה במחזיק המפתחות של מערכת ההפעלה כשהוא זמין, או בקובץ מקומי שרק בעליו יכולים לקרוא. אסימוני גישה של OAuth תקפים לשעה ומתרעננים דרך תהליך הכניסה. השתמשו ב-auth status לאבחון חיבור במקום להעתיק את קובץ אמצעי הגישה.

בטלו מכשיר או הרשאה בהגדרות ← סוכנים וגישת API, או הריצו auth logout כדי לצאת מהמכשיר המקומי הנוכחי. זה מפסיק גישה עתידית. זה אינו מבטל פוסטים שפורסמו או תזמונים ש-SosoAPI כבר קיבל; בדקו ונהלו אותם בנפרד.

נקודות קצה לאתחול אימות

ארבע נקודות הקצה agent-auth מתעדות את פרוטוקול הכניסה. השתמשו ב-CLI נתמך או בלקוח OAuth מרוחק כדי להיכנס; נקודות הקצה האלה אינן זמינות דרך api post. ‏Config, ‏request, ‏session ו-revoke-current מקבלים אמצעי גישה ושדות שונים. פעלו לפי הסכמה של כל נקודת קצה והשאירו אמצעי גישה של ההפעלה מחוץ לפלט וליומנים.