מדריך למתחילים ל-Java ללקוחות

במדריך למתחילים: תוך 10 דקות, יצרתם אפליקציה פשוטה של שורת הפקודה ב-Java שמבצעת בקשות ל-API של ההרשמה דרך הארגון.

דרישות מוקדמות

כדי להפעיל את המדריך למתחילים, צריך:

  • חשבון Google, החבר בחשבון הלקוח להרשמה דרך הארגון. קראו את המאמר תחילת העבודה.
  • Java 1.7 ומעלה.
  • Gradle 2.3 ומעלה.
  • גישה לאינטרנט ולדפדפן אינטרנט.

שלב 1: הפעלת ה-API של ההרשמה דרך הארגון

  1. בעזרת האשף הזה אפשר ליצור או לבחור פרויקט ב-Google Developers Console ולהפעיל את ה-API באופן אוטומטי. לוחצים על Continue (המשך), ואז על Credentials .
  2. לוחצים על Cancel (ביטול) בקטע 'יצירת פרטי כניסה'.
  3. בחלק העליון של הדף בוחרים בכרטיסייה מסך הסכמה ל-OAuth. בוחרים כתובת אימייל, מזינים שם מוצר אם הוא עדיין לא מוגדר, ולוחצים על Save.
  4. בוחרים בכרטיסייה Credentials, לוחצים על הלחצן Create credentials ובוחרים באפשרות OAuth client ID.
  5. בוחרים את סוג האפליקציה אחר, מזינים את השם "מדריך למתחילים" ולוחצים על הלחצן יצירה.
  6. לוחצים על אישור כדי לסגור את החלונית לקוח OAuth.
  7. לוחצים על Download JSON.
  8. מעבירים את הקובץ לספריית העבודה ומשנים את השם שלו ל-client_secret.json.

שלב 2: הכנת הפרויקט

פועלים לפי השלבים הבאים כדי להגדיר את פרויקט Gradle:

  1. מריצים את הפקודה הבאה כדי ליצור פרויקט חדש בספריית העבודה:

    gradle init --type basic
mkdir -p src/main/java src/main/resources

  2. מעתיקים את הקובץ client_secret.json שהורדתם בשלב 1 לספרייה src/main/resources/ שיצרתם למעלה.

  3. פותחים את קובץ ברירת המחדל build.gradle ומחליפים את התוכן שלו בקוד הבא:

apply plugin: 'java'
apply plugin: 'application'

mainClassName = 'CustomerQuickstart'
sourceCompatibility = 1.7
targetCompatibility = 1.7
version = '1.0'

repositories {
    mavenCentral()
}

dependencies {
    compile 'com.google.api-client:google-api-client:2.2.0'
    compile 'com.google.apis:google-api-services-androiddeviceprovisioning:v1-rev20230509-2.0.0'
    compile 'com.google.oauth-client:google-oauth-client-jetty:1.34.1'
}

שלב 3: הגדרת הדוגמה

יוצרים קובץ בשם src/main/java/CustomerQuickstart.java ומעתיקים את הקוד הבא ושומרים אותו.

import com.google.api.client.auth.oauth2.Credential;
import com.google.api.client.extensions.java6.auth.oauth2.AuthorizationCodeInstalledApp;
import com.google.api.client.extensions.jetty.auth.oauth2.LocalServerReceiver;
import com.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeFlow;
import com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.JsonFactory;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.client.util.store.FileDataStoreFactory;
import com.google.api.services.androiddeviceprovisioning.v1.AndroidProvisioningPartner;
import com.google.api.services.androiddeviceprovisioning.v1.model.Company;
import com.google.api.services.androiddeviceprovisioning.v1.model.CustomerListCustomersResponse;
import com.google.api.services.androiddeviceprovisioning.v1.model.CustomerListDpcsResponse;
import com.google.api.services.androiddeviceprovisioning.v1.model.Dpc;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.Arrays;
import java.util.List;

/** This class forms the quickstart introduction to the zero-touch enrollemnt customer API. */
public class CustomerQuickstart {

  // A single auth scope is used for the zero-touch enrollment customer API.
  private static final List<String> SCOPES =
      Arrays.asList("https://www.googleapis.com/auth/androidworkzerotouchemm");
  private static final String APP_NAME = "Zero-touch Enrollment Java Quickstart";
  private static final java.io.File DATA_STORE_DIR =
      new java.io.File(System.getProperty("user.home"), ".credentials/zero-touch.quickstart.json");

  // Global shared instances
  private static FileDataStoreFactory DATA_STORE_FACTORY;
  private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance();
  private static HttpTransport HTTP_TRANSPORT;

  static {
    try {
      HTTP_TRANSPORT = GoogleNetHttpTransport.newTrustedTransport();
      DATA_STORE_FACTORY = new FileDataStoreFactory(DATA_STORE_DIR);
    } catch (Throwable t) {
      t.printStackTrace();
      System.exit(1);
    }
  }

  /**
   * Creates a Credential object with the correct OAuth2 authorization for the user calling the
   * customer API. The service endpoint invokes this method when setting up a new service instance.
   *
   * @return an authorized Credential object.
   * @throws IOException
   */
  public static Credential authorize() throws IOException {
    // Load client secrets.
    InputStream in = CustomerQuickstart.class.getResourceAsStream("/client_secret.json");

    GoogleClientSecrets clientSecrets =
        GoogleClientSecrets.load(JSON_FACTORY, new InputStreamReader(in, "UTF-8"));

    // Ask the user to authorize the request using their Google Account
    // in their browser.
    GoogleAuthorizationCodeFlow flow =
        new GoogleAuthorizationCodeFlow.Builder(HTTP_TRANSPORT, JSON_FACTORY, clientSecrets, SCOPES)
            .setDataStoreFactory(DATA_STORE_FACTORY)
            .setAccessType("offline")
            .build();
    Credential credential =
        new AuthorizationCodeInstalledApp(flow, new LocalServerReceiver()).authorize("user");
    System.out.println("Credential file saved to: " + DATA_STORE_DIR.getAbsolutePath());
    return credential;
  }

  /**
   * Build and return an authorized zero-touch enrollment API client service. Use the service
   * endpoint to call the API methods.
   *
   * @return an authorized client service endpoint
   * @throws IOException
   */
  public static AndroidProvisioningPartner getService() throws IOException {
    Credential credential = authorize();
    return new AndroidProvisioningPartner.Builder(HTTP_TRANSPORT, JSON_FACTORY, credential)
        .setApplicationName(APP_NAME)
        .build();
  }

  /**
   * Runs the zero-touch enrollment quickstart app.
   *
   * @throws IOException
   */
  public static void main(String[] args) throws IOException {

    // Create a zero-touch enrollment API service endpoint.
    AndroidProvisioningPartner service = getService();

    // Get the customer's account. Because a customer might have more
    // than one, limit the results to the first account found.
    AndroidProvisioningPartner.Customers.List accountRequest = service.customers().list();
    accountRequest.setPageSize(1);
    CustomerListCustomersResponse accountResponse = accountRequest.execute();
    if (accountResponse.getCustomers().isEmpty()) {
      // No accounts found for the user. Confirm the Google Account
      // that authorizes the request can access the zero-touch portal.
      System.out.println("No zero-touch enrollment account found.");
      System.exit(-1);
    }
    Company customer = accountResponse.getCustomers().get(0);
    String customerAccount = customer.getName();

    // Send an API request to list all the DPCs available using the customer account.
    AndroidProvisioningPartner.Customers.Dpcs.List request =
        service.customers().dpcs().list(customerAccount);
    CustomerListDpcsResponse response = request.execute();

    // Print out the details of each DPC.
    java.util.List<Dpc> dpcs = response.getDpcs();
    for (Dpc dpcApp : dpcs) {
      System.out.format("Name:%s  APK:%s\n", dpcApp.getDpcName(), dpcApp.getPackageName());
    }
  }
}

שלב 4: הרצת הדוגמה

משתמשים בעזרה של מערכת ההפעלה כדי להריץ את הסקריפט בקובץ. במחשבי UNIX ו-Mac, מריצים את הפקודה הבאה במסוף:

gradle -q run

בפעם הראשונה שמפעילים את האפליקציה, צריך להעניק הרשאת גישה:

  1. האפליקציה מנסה לפתוח כרטיסייה חדשה בדפדפן ברירת המחדל. אם הפעולה נכשלה, כדאי להעתיק את כתובת ה-URL מהמסוף ולפתוח אותה בדפדפן. אם עוד לא התחברת לחשבון Google, תוצג בקשה להתחבר. אם יש לך מספר חשבונות Google, בדף הזה תוצג בקשה לבחור חשבון להרשאה.
  2. לוחצים על אישור.
  3. סוגרים את כרטיסיית הדפדפן – האפליקציה ממשיכה לפעול.

הערות

  • מאחר שספריית הלקוח של Google API מאחסנת נתוני הרשאה במערכת הקבצים, ההשקות הבאות לא יציגו בקשה להרשאה.
  • כדי לאפס את נתוני ההרשאה של האפליקציה, צריך למחוק את הקובץ ~/.credentials/zero-touch.quickstart.json ולהפעיל שוב את האפליקציה.
  • תהליך ההרשאה למתחילים יעזור לכם, למשל, לגבי אפליקציה של שורת פקודה. במאמר אפליקציות של שרת אינטרנט OAuth 2.0 מוסבר איך להוסיף הרשאה לאפליקציית אינטרנט.

פתרון בעיות

הנה כמה דברים נפוצים שכדאי לבדוק. מה הבעיה? נשמח לדעת איך זה עובד, ואנחנו נתקן את זה.

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

מידע נוסף