Guia de início rápido do PHP

Neste guia de início rápido, explicamos como configurar um aplicativo de linha de comando PHP simples que faz solicitações à API YouTube Data. Este guia de início rápido explica como fazer duas solicitações de API:

  1. Você vai usar uma chave de API, que identifica seu aplicativo, para recuperar informações sobre o canal do Google Developers no YouTube.
  2. Você vai usar um ID do cliente OAuth 2.0 para enviar uma solicitação autorizada que recupera informações sobre seu próprio canal do YouTube.

Pré-requisitos

Para executar este guia de início rápido, você precisará do seguinte:

  • PHP 5.4 ou mais recente com a interface de linha de comando (CLI) e a extensão JSON instaladas.
  • A ferramenta de gestão de dependências do Composer instalada globalmente {: target="_blank"}
  • A biblioteca de cliente das APIs do Google para PHP:
    • Se você não instalou a biblioteca de cliente: 
      composer require google/apiclient:^2.0
    • Se você já instalou a biblioteca de cliente, recomendamos atualizá-la para garantir que tenha as classes mais atualizadas para a biblioteca que está testando: 
      composer update google/apiclient --with-dependencies

Etapa 1: configurar o projeto e as credenciais

Crie ou selecione um projeto no Console de APIs. Conclua as seguintes tarefas no Console de APIs do projeto:

  1. No painel de biblioteca, procure a API YouTube Data v3. Clique na ficha da API em questão e verifique se ela está ativada no seu projeto.

  2. No painel de credenciais, crie duas credenciais:

    1. Crie uma chave de API. Você usará a chave de API para fazer solicitações de API que não exijam autorização do usuário. Por exemplo, você não precisa de autorização do usuário para recuperar informações sobre um canal público do YouTube.

    2. Crie um ID do cliente OAuth 2.0 Defina o tipo de aplicativo como Outro. Você precisa usar as credenciais do OAuth 2.0 para solicitações que exijam autorização do usuário. Por exemplo, você precisa da autorização do usuário para recuperar informações sobre o canal do YouTube do usuário autenticado no momento.

      Faça o download do arquivo JSON que contém suas credenciais do OAuth 2.0. O arquivo tem um nome como client_secret_CLIENTID.json, em que CLIENTID é o ID do cliente do projeto.

Etapa 2: configurar e executar a amostra

Use o widget do APIs Explorer no painel lateral para ver um exemplo de código e recuperar informações sobre o canal do Google Developers no YouTube. Essa solicitação usa uma chave de API para identificar o aplicativo e não requer autorização do usuário nem permissões especiais do usuário que executa a amostra.

  1. Abra a documentação do método channels.list da API.

  2. Nessa página, a seção "Casos de uso comuns" contém uma tabela que explica várias formas comuns de uso do método. A primeira lista da tabela é para listar os resultados por ID do canal.

    Clique no símbolo de código da primeira lista para abrir e preencher o APIs Explorer em tela cheia.

    Imagem que identifica o local do link do símbolo de código na tabela que lista os casos de uso da documentação channel.list. O texto alternativo para essa imagem identifica a imagem como um símbolo de código e especifica o caso de uso associado a esse link.

  3. O lado esquerdo das APIs de tela cheia mostra o seguinte:

    1. Abaixo do cabeçalho Solicitar parâmetros, há uma lista de parâmetros compatíveis com o método. Os valores dos parâmetros part e id precisam ser definidos. O valor do parâmetro id, UC_x5XG1OV2P6uZZ5FSM9Ttw, é o ID do canal do Google Developers do YouTube.

    2. Abaixo dos parâmetros, há uma seção chamada Credenciais. O menu suspenso nessa seção exibe o valor Chave de API. Por padrão, o APIs Explorer usa credenciais de demonstração para facilitar os primeiros passos. No entanto, você usará sua própria chave de API para executar o exemplo no local.

      Imagem que mostra as "Credenciais" no APIs Explorer em tela cheia e o menu suspenso com a opção "Chave de API" selecionada.

  4. O lado direito do APIs Explorer em tela cheia mostra guias com amostras de código em diferentes linguagens. Selecione a guia PHP.

  5. Copie o exemplo de código e salve-o em um arquivo chamado example.php.

  6. No exemplo transferido por download, encontre a string YOUR_API_KEY e substitua pela chave de API criada na etapa 1 deste guia de início rápido.

  7. Execute o exemplo na linha de comando. No diretório de trabalho, execute:

    php example.php

  8. O exemplo precisa executar a solicitação e exibir a resposta em STDOUT.

Etapa 3: executar uma solicitação autorizada

Nesta etapa, você modificará a amostra de código para que, em vez de recuperar informações sobre o canal do Google Developers no YouTube, ele recupere informações sobre seu canal do YouTube. Esta solicitação não exige autorização do usuário.

  1. Volte para a documentação do método channels.list da API.

  2. Na seção "Casos de uso comuns", clique no símbolo de código da terceira listagem na tabela. Esse caso de uso é chamar o método list para "my channel".

  3. Novamente, no lado esquerdo do APIs Explorer em tela cheia, você verá uma lista de parâmetros seguidas pela seção Credenciais. No entanto, há duas mudanças no exemplo em que você recuperou informações sobre o canal GoogleDevelopers:

    1. Na seção de parâmetros, em vez de definir o valor do parâmetro id, o valor do parâmetro mine precisa ser definido como true. Isso instrui o servidor de API a recuperar informações sobre o canal do usuário autenticado no momento.

    2. Na seção Credenciais, o menu suspenso precisa selecionar a opção para Google OAuth 2.0.

      Além disso, se você clicar no link Mostrar escopos, o escopo https://www.googleapis.com/auth/youtube.readonly precisará ser verificado.

      Imagem que mostra os escopos no APIs Explorer em tela cheia e a opção de usar as credenciais "Google OAuth 2.0" selecionadas.

  4. Assim como no exemplo anterior, selecione a guia PHP, copie a amostra de código e salve-a em example.php.

    No código, encontre a string YOUR_CLIENT_SECRET_FILE.json e substitua-a pelo local do arquivo de chave secreta do cliente que você salvou na etapa 1 deste guia de início rápido.

  5. Execute o exemplo na linha de comando. No diretório de trabalho, execute:

    php example.php

  6. Copie o URL do console e abra-o no navegador.

    Se ainda não estiver conectado à sua Conta do Google, você será solicitado a fazer login. Se você tiver feito login em várias Contas do Google, precisará escolher uma para usar na autorização.

  7. Clique no botão para conceder ao seu aplicativo acesso aos escopos especificados no exemplo de código.

  8. Copie o código de autenticação do navegador e cole-o no terminal. Feche a guia do navegador usada para o fluxo de autenticação.

    A resposta da API será mostrada novamente em STDOUT.

Leitura adicional