יצירת השילוב המותאם אישית הראשון

נתמך ב:

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

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

בחירת המוצר לשילוב

  1. בדוגמה הזו, נשלב עם המוצר WHOIS XML API, כלי חינמי בקוד פתוח שמספק גישת API בפורמט XML לנתוני דומיין, כולל שם רושם הדומיין, הארגון, כתובת האימייל, כתובת הרישום, פרטי הרשם, תאריכי היצירה, התפוגה והעדכון של הדומיין, זמינות הדומיין והגיל שלו.
  2. עוברים אל WHOIS XML API/ ונרשמים.
  3. אחרי שנכנסים לחשבון, מקבלים את מפתח ה-API מדף החשבון: https://user.whoisxmlapi.com/products
  4. משתמשים במפתח ה-API הזה בפרמטרים של השילוב.

יצירת השילוב המותאם אישית הראשון ב-IDE

כדי ליצור את השילוב המותאם אישית הראשון בסביבת הפיתוח המשולבת (IDE), פועלים לפי השלבים הבאים:

  1. בדף Response > IDE, לוחצים על add Add כדי להוסיף פריט IDE חדש.
  2. בוחרים באפשרות שילוב ומזינים שם לשילוב.
  3. לוחצים על יצירה. השילוב מופיע עם סמל שילוב מותאם אישית.
  4. לוחצים על הגדרות.
  5. בתיבת הדו-שיח של השילוב, מגדירים את הסמל, התיאור, התלות ב-Python ופרמטרים של שילוב.
    בדוגמה הזו מופיעים הפרטים הבאים:
    • תמונה של הלוגו של WhoisXML API מועלית. התמונה הזו מופיעה במרכז התוכן עם השילוב.
    • סמל SVG נוסף לצד השילוב ב-IDE עם תיאור קצר ופרמטר אחד, מפתח ה-API. זהו הפרמטר שנדרש למוצר Who Is API בפורמט XML כדי להגדיר את השילוב.
    • לא צריך ספריות Python נוספות לשילוב הזה. כברירת מחדל, ההגדרה של השילוב היא להפעלה ב-Python 3.7, ואפשר לשנות את הגרסה בהגדרות.

הגדרת מופע ברירת המחדל

אחרי שיוצרים את השילוב, אפשר לראות אותו ב-Google SecOps בקטע Response Integrations (שילובים של תגובות). כדי למצוא אותו, אפשר לחפש את שם השילוב בסרגל החיפוש או לסנן את סוג השילוב לפי Custom Integrations (שילובים בהתאמה אישית). השילוב יופיע עם התמונה, התיאור והפרמטר שהגדרתם עבורו.

  1. לוחצים על הגדרות > הגדרת מופע ברירת מחדל.
  2. מזינים את מפתח ה-API ולוחצים על שמירה.
  3. אופציונלי: כדי להגדיר את השילוב לסביבה אחרת (לא לסביבת ברירת המחדל), לוחצים על הכרטיסייה Configure ומגדירים פרמטרים לאותו מופע.

יצירת פעולת פינג

  1. ב-Response > IDE, לוחצים על add Add > Add New IDE Item.
  2. בוחרים בלחצן הבחירה פעולה, מזינים שם ובוחרים את השילוב.
  3. לוחצים על יצירה. בודקים את תבנית הקוד שנוצרה.
  4. מעתיקים את הקוד הבא לפעולה Ping. הפעולה Ping משתמשת בפרמטר API Key שהגדרתם לשילוב ומציבה אותו בכתובת ה-URL שסופקה על ידי המוצר למטרות בדיקה. פרטים נוספים מופיעים במאמר בנושא יצירת פעולות בהתאמה אישית. 
    5. from SiemplifyAction import SiemplifyAction
from SiemplifyUtils import output_handler
import requests

INTEGRATION_NAME = "My first Integration - Whois XML API"
SCRIPT_NAME = "Whois XML API Ping"

@output_handler
def main():
    siemplify = SiemplifyAction()
    siemplify.script_name = SCRIPT_NAME

    api_key = siemplify.extract_configuration_param(provider_name=INTEGRATION_NAME,
                                                    param_name="API Key")
    url = "https://www.whoisxmlapi.com/whoisserver/WhoisService?apiKey={api_key}&domainName=google.com".format(api_key=api_key)

    res = requests.get(url)
    res.raise_for_status()

    if "ApiKey authenticate failed" in res.content.decode("utf-8"):
        raise Exception("Error, bad credentials")

    siemplify.end("Successful Connection", True)
if __name__ == "__main__":
    main()
  5. לוחצים על המתג שמעל הפעולה ואז על שמירה כדי לבדוק את החיבור למוצר.
  6. נכנסים אל Google SecOps Marketplace, לוחצים על Configure default instance (הגדרת מופע ברירת מחדל) ומוודאים שהשילוב מוגדר ונשמר.
  7. לוחצים על בדיקה כדי לבדוק את השילוב. אם החיבור בוצע בהצלחה, יופיע סימן וי ירוק. אם החיבור נכשל, יופיע סימן X עם השגיאה שמשויכת אליו.
  8. אחרי שתשלימו את תהליך האימות, תיצרו את הפעולה המותאמת אישית הראשונה בשילוב המותאם אישית. פרטים נוספים מופיעים במאמר יצירת פעולות בהתאמה אישית.

הבעיה עדיין לא נפתרה? קבלת תשובות מחברי הקהילה וממומחי Google SecOps.