דלגו לתוכן

Authentication

Agent Analytics משתמש בשני credentials שונים. יש להם תפקידים שונים, ולא צריך להחליף ביניהם.

השתמשו ב-API key עבור:

  • קריאת נתוני אנליטיקה
  • יצירה או רשימה של פרויקטים
  • נקודות קצה ברמת החשבון
  • גישה ישירה ל-API מתוך סקריפטים, כלים וסוכנים

העבירו אותו עם כותרת X-API-Key או עם query parameter בשם ?key=.

Terminal window
curl "https://api.agentanalytics.sh/stats?project=my-site&since=7d" \
-H "X-API-Key: aak_..."

התייחסו אליו כחומר סודי.

השתמשו ב-project token עבור:

  • POST /track
  • POST /track/batch
  • סניפט הטרקר בדפדפן שמוטמע באתר שלכם

הטוקן ציבורי בכוונה. הוא מזהה את הפרויקט עבור קליטת אירועים, ולכן צפוי להופיע ב-HTML.

<script defer src="https://api.agentanalytics.sh/tracker.js"
data-project="my-site"
data-token="aat_..."></script>

אל תשימו את ה-API key בתוך הטרקר בצד הלקוח. הטרקר משתמש רק ב-project token הציבורי.

אם אתם משתמשים ב-CLI הרשמי, הוא מספק שתי פקודות נוחות לעבודה מקומית סביב ה-API key:

  • npx @agent-analytics/cli login --token aak_... שומר מקומית את ה-API key לקריאות CLI עתידיות.
  • npx @agent-analytics/cli logout מוחק את auth המקומי השמור של ה-CLI.

logout לא מבטל את ה-API key בשרת. השתמשו ב-revoke-key כשאתם רוצים לפסול את המפתח הישן ולהנפיק חדש.

אם הגדרתם AGENT_ANALYTICS_API_KEY בסביבת shell, ה-CLI ימשיך להשתמש במשתנה הזה גם אחרי logout עד שתבטלו אותו.