نمای کلی

رابط برنامه‌نویسی کاربردی مرکز هشدار (Alert Center API) به شما امکان می‌دهد هشدارهایی را که بر دامنه شما تأثیر می‌گذارند، مدیریت کنید. هشدار، هشداری در مورد یک مشکل امنیتی بالقوه است که گوگل شناسایی کرده است. هشدارها شامل اطلاعات زیر هستند:

• منبعی که هشدار از آن سرچشمه گرفته است.
• نام هشدار.
• زمان وقوع این هشدار.
• داده‌های خاص مرتبط با این هشدار.

مدیران دامنه می‌توانند هشدارها را به صورت دستی از کنسول مدیریت گوگل مشاهده و مدیریت کنند. API مرکز هشدار به برنامه‌هایی که می‌سازید اجازه می‌دهد داده‌های هشدار و بازخورد هشدار را بازیابی کنند. این API همچنین می‌تواند برای هشدارهای موجود، بازخورد هشدار جدیدی ایجاد کند.

برای مثال، یک برنامه‌ی نظارتی می‌تواند از API مرکز هشدار برای بازیابی جدیدترین هشدارها برای یک دامنه، اولویت‌بندی آنها و سپس اطلاع‌رسانی به اعضای سازمان شما استفاده کند. پس از اینکه تیم شما به هشدار پاسخ داد، برنامه می‌تواند بر اساس یافته‌های خود، بازخوردی را به هشدار پیوست کند.

استفاده از API مرکز هشدار

قبل از استفاده از API مرکز هشدار، باید یک پروژه Cloud Platform جدید راه‌اندازی کنید و API مرکز هشدار را فعال کنید . پروژه شما باید هنگام دسترسی به API از یک حساب کاربری سرویس استفاده کند.

زمانی که برنامه شما یک پروژه ابری داشته باشد که پیش‌نیازها را برآورده کند و به درستی مجاز باشد، می‌تواند درخواست‌های Alert Center API REST را ارسال کند. ارسال درخواست‌های API هنگام استفاده از کتابخانه‌های کلاینت موجود آسان‌تر است.

مثال زیر نحوه فهرست کردن هشدارهای موجود با استفاده از API را نشان می‌دهد:

// 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);