מפתח API מאפשר לאפליקציה אחרת, כמו מערכת ה-CRM שלכם או קוד שכתבתם, לגשת לחשבון אקטיב טרייל שלכם בלי הסיסמה שלכם. כל בקשת API חייבת לכלול מפתח בכותרת Authorization.
יצירת מפתח API
משתמשים עם הרשאות מנהל יכולים ליצור מפתחות API ולצפות בהם.
- היכנסו לאינטגרציות ← API ← מפתחות API ולחצו על חדש.
- הזינו בשם את שם האפליקציה שמשתמשת במפתח, למשל "Salesforce".
- לא חובה: הוסיפו תיאור, כתובות IP מורשות (המפתח יעבוד רק מכתובות ה-IP האלה, מופרדות בפסיקים) ותאריך פקיעת תוקף.
- שמרו, והעתיקו את המפתח מיד. הוא מוצג פעם אחת בלבד.
למידע נוסף על הגדרות המפתח, ראו מפתחות API והרשאה.
השבתת מפתח API
אם ייתכן שמפתח נחשף, או שהאינטגרציה שהשתמשה בו כבר לא בשימוש, השביתו אותו: פתחו את המפתח ברשימת מפתחות ה-API, בטלו את הסימון פעיל ושמרו.
שמירה על המפתחות
מפתח API נותן גישה מלאה לחשבון אקטיב טרייל שלכם, ולכן שמרו עליו כמו על סיסמה.
- תנו לכל אינטגרציה מפתח משלה עם שם ברור. אם מפתח אחד נחשף, אפשר להשבית אותו בלי לפגוע באינטגרציות האחרות.
- אם אתם יודעים מאילו כתובות IP ישתמשו במפתח, הוסיפו אותן בכתובות IP מורשות.
- למפתחות של בדיקות ופיתוח הגדירו תאריך פקיעת תוקף.
- אל תציגו מפתחות בצילומי מסך, בסרטונים או בתיעוד. טשטוש לא תמיד מספיק; חתכו את המפתח מהתמונה לגמרי.
- אל תשלחו מפתחות במייל. אם צריך לתת גישה, צרו לשם כך מפתח חדש, כדי שתוכלו להשבית אותו אחר כך.
- אם מסירים משתמש מהחשבון, גם מפתחות ה-API שהוא יצר מוסרים.
תמיכה ב-API
התמיכה של אקטיב טרייל יכולה לעזור בשאלות על החשבון ועל המפתחות, אבל בדיקה מעמיקה של בעיות API ועבודת פיתוח עשויות לקחת יותר זמן. לרשימה המלאה של ה-endpoints, ראו את מדריכי ה-API reference בחלק הזה.