Guide de démarrage rapide pour PHP

Ce guide de démarrage rapide explique comment configurer une application de ligne de commande PHP simple qui envoie des requêtes à l'API YouTube Data. Ce guide de démarrage rapide explique comment effectuer deux requêtes API:

  1. Vous allez utiliser une clé API qui identifie votre application pour récupérer des informations sur la chaîne YouTube GoogleDevelopers.
  2. Vous utiliserez un ID client OAuth 2.0 pour envoyer une requête autorisée qui récupère des informations sur votre propre chaîne YouTube.

Prérequis

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

  • PHP 5.4 ou version ultérieure avec l'interface de ligne de commande (CLI) et l'extension JSON installées
  • L'outil de gestion des dépendances Composer est installé à l'échelle mondiale {: target="_blank"}.
  • La bibliothèque cliente des API Google pour PHP :
    • Si vous n'avez pas encore installé la bibliothèque cliente :
      composer require google/apiclient:^2.0
    • Si vous avez déjà installé la bibliothèque cliente, nous vous recommandons de la mettre à jour pour vous assurer que vous disposez des classes les plus récentes pour la bibliothèque que vous testez :
      composer update google/apiclient --with-dependencies

Étape 1: Configurez votre projet et vos identifiants

Créez ou sélectionnez un projet dans la console API. Effectuez les tâches suivantes dans la console d'API pour votre projet:

  1. Dans le panneau de la bibliothèque, recherchez l'API YouTube Data v3. Cliquez sur la fiche de cette API et assurez-vous que l'API est activée pour votre projet.

  2. Dans le panneau des identifiants, créez deux identifiants:

    1. Créer une clé API Vous utiliserez la clé API pour effectuer des requêtes API qui ne nécessitent pas d'autorisation de l'utilisateur. Par exemple, vous n'avez pas besoin d'une autorisation utilisateur pour récupérer des informations sur une chaîne YouTube publique.

    2. Créer un ID client OAuth 2.0 Définissez le type d'application sur Autre. Vous devez utiliser les identifiants OAuth 2.0 pour les requêtes nécessitant une autorisation utilisateur. Par exemple, vous avez besoin d'une autorisation utilisateur pour récupérer des informations sur la chaîne YouTube de l'utilisateur actuellement authentifié.

      Téléchargez le fichier JSON contenant vos identifiants OAuth 2.0. Le fichier porte un nom tel que client_secret_CLIENTID.json, où CLIENTID est l'ID client de votre projet.

Étape 2: Configurez et exécutez l'exemple

Utilisez le widget APIs Explorer dans le panneau latéral pour obtenir un exemple de code permettant de récupérer des informations sur la chaîne YouTube GoogleDevelopers. Cette requête utilise une clé API pour identifier votre application. Elle ne nécessite aucune autorisation de l'utilisateur ni aucune autorisation spéciale de la part de l'utilisateur exécutant l'exemple.

  1. Ouvrez la documentation sur la méthode channels.list de l'API.

  2. Sur cette page, la section "Cas d'utilisation courants" contient un tableau qui explique plusieurs façons courantes d'utiliser la méthode. La première liste du tableau concerne les résultats par ID de canal.

    Cliquez sur le symbole de code de la première fiche pour ouvrir et renseigner l'explorateur d'API en plein écran.

    Image qui indique l'emplacement du lien du symbole de code dans le tableau qui répertorie les cas d'utilisation de la documentation de channel.list. Le texte alt de cette image identifie l'image en tant que symbole de code et spécifie le cas d'utilisation associé à ce lien.

  3. La partie gauche de l'explorateur d'API en plein écran affiche les éléments suivants:

    1. Sous l'en-tête Paramètres de requête, la liste des paramètres est compatible avec la méthode. Les valeurs des paramètres part et id doivent être définies. La valeur du paramètre id, UC_x5XG1OV2P6uZZ5FSM9Ttw, correspond à l'ID de la chaîne YouTube Google Developers.

    2. Sous les paramètres se trouve une section intitulée Identifiants. Le menu déroulant de cette section doit afficher la valeur API key (Clé API). Par défaut, APIs Explorer utilise des identifiants de démonstration pour faciliter la mise en route. Toutefois, vous utiliserez votre propre clé API pour exécuter l'exemple en local.

      Image montrant les "Identifiants" dans l'explorateur d'API en plein écran et le menu déroulant avec l'option "Clé API" sélectionnée.

  4. La partie droite de l'explorateur d'API en plein écran affiche des onglets contenant des exemples de code dans différents langages. Sélectionnez l'onglet PHP.

  5. Copiez l'exemple de code et enregistrez-le dans un fichier nommé example.php.

  6. Dans l'exemple que vous avez téléchargé, recherchez la chaîne YOUR_API_KEY et remplacez-la par la clé API que vous avez créée à l'étape 1 de ce démarrage rapide.

  7. Exécutez l'exemple à partir de la ligne de commande. Dans votre répertoire de travail, exécutez la commande suivante:

    php example.php

  8. L'exemple doit exécuter la requête et afficher la réponse dans STDOUT.

Étape 3: Exécuter une requête autorisée

Au cours de cette étape, vous allez modifier l'exemple de code afin qu'au lieu de récupérer des informations sur la chaîne YouTube GoogleDevelopers, il récupère des informations sur votre chaîne YouTube. Cette demande nécessite une autorisation de l'utilisateur.

  1. Revenez à la documentation de la méthode channels.list de l'API.

  2. Dans la section "Cas d'utilisation courants", cliquez sur le symbole de code de la troisième fiche du tableau. Ce cas d'utilisation consiste à appeler la méthode list pour "my channel".

  3. Là encore, sur la gauche de l'explorateur d'API en plein écran, vous verrez une liste de paramètres suivie de la section Identifiants. Cependant, il existe deux modifications dans l'exemple où vous avez récupéré des informations sur le canal Google Developers:

    1. Dans la section des paramètres, au lieu de la valeur du paramètre id, la valeur du paramètre mine doit être définie sur true. Cela indique au serveur d'API de récupérer les informations sur le canal de l'utilisateur actuellement authentifié.

    2. Dans la section Credentials (Identifiants), le menu déroulant doit sélectionner l'option Google OAuth 2.0.

      En outre, si vous cliquez sur le lien Afficher les champs d'application, vous devez cocher le champ https://www.googleapis.com/auth/youtube.readonly.

      Image montrant les champs d'application dans l'explorateur d'API en plein écran et l'option d'utilisation des identifiants "Google OAuth 2.0" sélectionnée.

  4. Comme dans l'exemple précédent, sélectionnez l'onglet PHP, copiez l'exemple de code et enregistrez-le dans example.php.

    Dans le code, recherchez la chaîne YOUR_CLIENT_SECRET_FILE.json et remplacez-la par l'emplacement du fichier secret du client que vous avez téléchargé à l'étape 1 de ce guide de démarrage rapide.

  5. Exécutez l'exemple à partir de la ligne de commande. Dans votre répertoire de travail, exécutez la commande suivante:

    php example.php

  6. Copiez l'URL à partir de la console et ouvrez-la dans votre navigateur.

    Si vous n'êtes pas déjà connecté à votre compte Google, vous serez invité à le faire. Si vous êtes connecté à plusieurs comptes Google, vous serez invité à sélectionner le compte à utiliser pour l'autorisation.

  7. Cliquez sur le bouton pour autoriser votre application à accéder aux champs d'application spécifiés dans votre exemple de code.

  8. Copiez le code d'authentification fourni par le navigateur et collez-le dans votre terminal. Vous pouvez ensuite fermer l'onglet du navigateur utilisé pour le flux d'authentification.

    La réponse de l'API doit de nouveau être affichée sur STDOUT.

Complément d'informations