פיתוח השילוב המותאם אישית הראשון שלכם

נתמך ב:

במאמר הזה מוסבר איך ליצור שילוב בהתאמה אישית בסביבת הפיתוח המשולבת (IDE) עם אותו מבנה כמו של שילובים מסחריים. שילובים בהתאמה אישית מופיעים ב-Content Hub, שם אפשר להגדיר אותם לסביבות שונות לשימוש בפלייבוקים, בפעולות ידניות ובסוכנים מרוחקים. אפשר גם לייבא ולייצא אותם, כמו פריטים אחרים ב-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. בוחרים באפשרות Integration ומזינים שם לשילוב.
  3. לוחצים על יצירה. השילוב מופיע עם סמל של שילוב בהתאמה אישית.
  4. לוחצים על הגדרות.
  5. בתיבת הדו-שיח של השילוב, מגדירים את הסמל, התיאור, יחסי התלות של Python והפרמטרים של השילוב.
    בדוגמה הזו, הפרטים הבאים מופיעים:
    • תמונה של הלוגו של WhoisXML API. התמונה הזו מופיעה במרכז התוכן עם השילוב.
    • סמל SVG נוסף לצד השילוב ב-IDE עם תיאור קצר ופרמטר אחד, מפתח ה-API. זה הפרמטר שנדרש למוצר Who Is API בפורמט XML כדי להגדיר את השילוב.
    • לא צריך ספריות Python נוספות בשביל השילוב הזה. כברירת מחדל, השילוב מוגדר לפעול ב-Python 3.11, ואפשר לשנות את הגרסה בהגדרות.

הגדרת המכונה שמוגדרת כברירת מחדל

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

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

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

  1. ב-Response > IDE, לוחצים על add Add > Add New IDE Item.
  2. בוחרים בכפתור הבחירה Action, נותנים שם ובוחרים את השילוב.
  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.