Guia de início rápido do PHP

Este guia de início rápido explica como configurar um aplicativo de linha de comando PHP simples que faz solicitações à API YouTube Data. Na verdade, este guia 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 YouTube do GoogleDevelopers.
  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ê precisa de:

  • PHP 5.4 ou mais recente com a interface de linha de comando (CLI) e a extensão JSON instalada.
  • A ferramenta de gestão de dependências do Composer instalada globalmente
  • A biblioteca de cliente de APIs do Google para PHP:
    • Se você ainda 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 você 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 do Cloud. Conclua as seguintes tarefas no console do Cloud para seu projeto:

  1. No painel da biblioteca, pesquise a API YouTube Data v3. Clique na listagem dessa API e verifique se ela está ativada para seu projeto.

  2. No painel de credenciais, crie duas credenciais:

    1. Criar uma chave de API : você vai usar a chave de API para fazer solicitações de API que não exigem autorização do usuário. Por exemplo, não é necessário autorização do usuário para recuperar informações sobre um canal público do YouTube.

    2. Criar um ID do cliente OAuth 2.0 : defina o tipo de aplicativo como Aplicativo para computador. Você precisa usar credenciais do OAuth 2.0 para solicitações que exigem autorização do usuário. Por exemplo, você precisa de 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 seu projeto.

Etapa 2: configurar e executar o exemplo

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

  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 maneiras comuns de usar o método. A primeira listagem na tabela é para listar resultados por ID do canal.

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

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

  3. O lado esquerdo do APIs Explorer em tela cheia mostra o seguinte:

    1. Abaixo do cabeçalho Parâmetros de solicitação, 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 YouTube do GoogleDevelopers.

    2. Abaixo dos parâmetros, há uma seção chamada Credenciais. O menu suspenso nessa seção precisa mostrar o valor Chave de API. As APIs Explorer usam credenciais de demonstração por padrão para facilitar o início. No entanto, você vai usar sua própria chave de API para executar o exemplo localmente.

      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 exemplos 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 que você fez o download, encontre a string YOUR_API_KEY e substitua-a pela chave de API que você criou 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 imprimir a resposta para STDOUT.

Etapa 3: executar uma solicitação autorizada

Nesta etapa, você vai modificar o exemplo de código para que, em vez de recuperar informações sobre o canal do YouTube do GoogleDevelopers, ele recupere informações sobre seu canal do YouTube. Essa solicitação exige autorização do usuário.

  1. Volte à 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 "meu canal".

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

    1. Na seção de parâmetros, em vez de o valor do parâmetro id ser definido, 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 OAuth 2.0 do Google.

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

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

  4. Como no exemplo anterior, selecione a guia PHP , copie o exemplo de código e salve-o 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ê fez o download 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 você ainda não fez login na sua Conta do Google, será solicitado que você faça login. Se você estiver conectado a várias Contas do Google, será necessário selecionar uma conta para usar na autorização.

  7. Clique no botão para conceder ao 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. Em seguida, feche a guia do navegador usada para o fluxo de autenticação.

    A resposta da API precisa ser impressa novamente em STDOUT.

Leitura adicional