סקירה כללית

ה-API של מרכז ההתראות מאפשר לנהל התראות שמשפיעות על הדומיין שלכם. התראה היא אזהרה על בעיית אבטחה אפשרית ש-Google זיהתה. ההתראות כוללות את המידע הבא:

  • המקור שממנו הגיעה ההתראה.
  • שם ההתראה.
  • מועד ההתרעה הזו.
  • נתונים ספציפיים המשויכים להתראה זו.

מנהלי דומיינים יכולים לראות ולנהל התראות באופן ידני ממסוף Google Admin. ה-API של מרכז ההתראות מאפשר לאפליקציות שאתם מפתחים לאחזר נתוני התראות ומשוב על התראות. ממשק ה-API יכול גם ליצור משוב חדש על התראות קיימות.

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

שימוש ב-Alert Center API

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

אחרי שבאפליקציה שלכם יש פרויקט ב-Cloud שעומד בדרישות המוקדמות ומורשים להשתמש בה, היא יכולה לשלוח בקשות REST ל-API למרכז ההתראות. קל יותר לשלוח בקשות API באמצעות ספריות הלקוח הזמינות.

הדוגמה הבאה מראה איך לרשום התראות זמינות באמצעות ה-API:

Java

// First, authorize the API and create a client to make requests with.
URL serviceAccountUrl = AuthUtils.class.getResource("/client_secret.json");
GoogleCredentials credentials =  ServiceAccountCredentials
    .fromStream(serviceAccountUrl.openStream())
    .createDelegated("admin@xxxx.com")
    .createScoped(Collections.singleton("https://www.googleapis.com/auth/apps.alerts"));
ApacheHttpTransport transport = new ApacheHttpTransport();
HttpCredentialsAdapter adapter = new HttpCredentialsAdapter(credentials);
AlertCenter alertCenter = new AlertCenter.Builder(transport, new JacksonFactory(), adapter)
    .setApplicationName("Alert Center client")
    .build();

// List alerts in pages, printing each alert discovered.
String pageToken = null;
do {
  ListAlertsResponse listResponse = service.alerts().list().setPageToken(pageToken)
      .setPageSize(20).execute();
  if (listResponse.getAlerts() != null) {
    for (Alert alert : listResponse.getAlerts()) {
      System.out.println(alert);
    }
  }
  pageToken = listResponse.getNextPageToken();
} while (pageToken != null);