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

הצגה כ-Markdown פתיחה ב-ChatGPT פתיחה ב-Claude

ה-API של Pristo מזהה את המערכת שלכם לפי מפתח API שאתם שולחים בכותרת X-API-Key של כל בקשה. יוצרים את המפתח במערכת Pristo CX, בלשונית ניהול > מפתחות API, והוא שייך לתוכנית שנבחרה בזמן היצירה.

לפני שמתחילים

תפקיד: מנהל/ת חשבון או מנהל/ת תוכנית של התוכנית. ראו תפקידים והרשאות.
חבילה: החבילה הסטנדרטית או חבילת פרימיום. בחבילה החינמית הדף מפתחות API לא מופיע.
תוכנית: עברו לתוכנית שהמפתח מיועד לה בלחיצה על שם התוכנית בכותרת העליונה, כמו שמוסבר בדף ניווט במערכת Pristo CX. אירועים שתשלחו עם המפתח ייכנסו לאוכלוסייה של התוכנית הזו. ראו מילון מונחים.

שלבים

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

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

התוצאה

המפתח מופיע ברשימה. בעמודה שם מופיע השם שלו, בעמודה קידומת מופיעים 24 התווים הראשונים שלו, בעמודה פעיל מופיע הערך כן, ובעמודה מועד יצירה מופיע מועד היצירה שלו. מפתח נראה כך: pristo_live_pk_ ואחריו 32 אותיות וספרות.

שלחו את המפתח בכל בקשה:

curl -X POST "https://api.pristo.io/v1/events/send" \
  -H "X-API-Key: $PRISTO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type": "purchase", "contact": {"id": "CUST-1042", "email": "dana@example.com"}}'

ניהול מפתחות

פתחו את התפריט בסוף השורה של המפתח:

האפשרות הפוך ללא פעיל משביתה את המפתח. הבקשה הבאה שתשתמש בו תקבל 401 Unauthorized.
האפשרות הפוך לפעיל מפעילה מחדש מפתח לא פעיל. מפתח שהופעל נספר במכסה של 10 המפתחות הפעילים, והחשבון חייב להיות בחבילה הסטנדרטית או בחבילת פרימיום.
האפשרות מחיקה מופיעה רק במפתח לא פעיל, והיא מוחקת אותו מהרשימה לצמיתות.

כדי לשנות את השם של מפתח, לחצו על כפתור העיפרון שליד השם. כדי להחליף מפתח (רוטציה), צרו מפתח חדש, העבירו את המערכת שלכם להשתמש בו, ואז השביתו ומחקו את המפתח הישן.

מגבלות

עד 10 מפתחות API פעילים לכל חשבון, בכל התוכניות יחד. מפתחות לא פעילים לא נספרים.
שם של מפתח הוא באורך 1 עד 50 תווים.
ברשימה מופיעים רק המפתחות של התוכנית שנבחרה.

פתרון בעיות

לא מצאתי איפה יוצרים מפתח. אם הלשונית ניהול לא מופיעה בתפריט הראשי, התפקיד שלכם בתוכנית הזו הוא משתמש/ת תוכנית: פנו לאחד ממנהלי החשבון או ממנהלי התוכנית. אם בלשונית ניהול אין את הדף מפתחות API, החשבון נמצא בחבילה החינמית.

כל בקשה מחזירה 401. הכותרת X-API-Key חסרה, המפתח שגוי, או שהמפתח הושבת או נמחק. בדקו ברשימה את הערך בעמודה פעיל של המפתח, ואת שם הכותרת.

בקשה מחזירה 400 עם Value is invalid. ערך הכותרת קצר מ-24 תווים. העתיקו שוב את המפתח המלא. ראו שגיאות API.

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