Guide de démarrage rapide de Java pour les clients

Suivez les étapes de ce guide de démarrage rapide. En 10 minutes environ, vous disposez d'une application de ligne de commande Java simple qui envoie des requêtes à l'API d'inscription sans contact du client.

Prérequis

Pour exécuter ce guide de démarrage rapide, vous avez besoin des éléments suivants:

Étape 1: Activez l'API d'enregistrement sans contact

  1. Utilisez cet assistant pour créer ou sélectionner un projet dans la Google Developers Console et activer automatiquement l'API. Cliquez sur Continuer, puis sur Accéder aux identifiants.
  2. Cliquez sur Annuler dans la boîte de dialogue "Créer des identifiants".
  3. En haut de la page, sélectionnez l'onglet OAuth consent screen (Écran d'autorisation OAuth). Sélectionnez une adresse e-mail, saisissez un nom de produit (Product name) si ce n'est pas déjà fait, puis cliquez sur le bouton Save (Enregistrer).
  4. Sélectionnez l'onglet Identifiants, cliquez sur le bouton Créer des identifiants, puis sélectionnez ID client OAuth.
  5. Sélectionnez le type d'application Other, saisissez le nom "quickstart", puis cliquez sur le bouton Create.
  6. Cliquez sur OK pour fermer le panneau Client OAuth.
  7. Cliquez sur Télécharger au format JSON.
  8. Déplacez le fichier dans votre répertoire de travail et renommez-le client_secret.json.

Étape 2: Préparez le projet

Pour configurer votre projet Gradle, procédez comme suit:

  1. Exécutez la commande suivante pour créer un projet dans le répertoire de travail:

    gradle init --type basic
    mkdir -p src/main/java src/main/resources
    
  2. Copiez le fichier client_secret.json que vous avez téléchargé à l'étape 1 dans le répertoire src/main/resources/ que vous avez créé ci-dessus.

  3. Ouvrez le fichier build.gradle par défaut et remplacez son contenu par le code suivant:

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'
}

Étape 3: Configurez l'exemple

Créez un fichier nommé src/main/java/CustomerQuickstart.java et copiez-le dans le code suivant, puis enregistrez le fichier.

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());
    }
  }
}

Étape 4: Exécuter l'exemple

Utilisez l'aide de votre système d'exploitation pour exécuter le script du fichier. Sur les ordinateurs UNIX et Mac, exécutez la commande ci-dessous dans votre terminal:

gradle -q run

La première fois que vous exécutez l'application, vous devez autoriser l'accès:

  1. L'application essaie d'ouvrir un nouvel onglet dans votre navigateur par défaut. Si cela ne fonctionne pas, copiez l'URL à partir de la console et ouvrez-la dans votre navigateur. Si vous n'êtes pas encore connecté à votre compte Google, vous êtes invité à le faire. Si vous êtes connecté à plusieurs comptes Google, la page vous invite à sélectionner un compte pour l'autorisation.
  2. Cliquez sur Accepter.
  3. Fermez l'onglet du navigateur. L'application continue de fonctionner.

Notes

  • Étant donné que la bibliothèque cliente des API Google stocke les données d'autorisation dans le système de fichiers, les lancements suivants ne vous demanderont pas d'autorisation.
  • Pour réinitialiser les données d'autorisation de l'application, supprimez le fichier ~/.credentials/zero-touch.quickstart.json, puis exécutez à nouveau l'application.
  • Le flux d'autorisation de ce guide de démarrage rapide est idéal pour une application de ligne de commande. Pour savoir comment ajouter une autorisation à une application Web, consultez la section Applications de serveur Web OAuth 2.0.

Dépannage

Voici quelques vérifications courantes à effectuer. Signalez-nous le problème lié au guide de démarrage rapide. Nous nous efforcerons de le résoudre.

  • Vérifiez que vous autorisez les appels d'API avec le compte Google qui est membre de votre compte client d'inscription sans contact. Essayez de vous connecter au portail d'inscription sans contact avec le même compte Google pour tester votre accès.
  • Vérifiez que le compte a accepté les dernières conditions d'utilisation sur le portail. Consultez Comptes client.

En savoir plus