Criação de credenciais para api's externas

Google Calendar, Youtube e Vimeo

Nesta publicação, vamos ensinar como criar credenciais de api's do Google Calendar, Youtube e Vimeo para utilizar em integrações de produtos da No Boss Extensions.

Google Calendar

Introdução:

  • Apresentaremos aqui uma passo a passo simplificado. Para mais informações, você pode acessar a documentação do Google.
  • O requisito para criar as credenciais é você ter uma conta criada no Google, podendo ser uma conta gratuita ou paga.

Inicie ativando a API do Google Calendar em sua conta Google

  • Acesse a biblioteca de API's do Google clicando aqui e utilizando o seu login do Google.
  • Pesquise por "Google Calendar API" e selecione o item correspondente.
  • Na nova página aberta clique no botão"Ativar" ou "Gerenciar" (quando já está ativo).
  • Feche a aba do navegador.

Crie um 'aplicativo' na conta do Google com permissões de acesso:

  • Acesse a página de "consentimento oAuth" do Google Calendar API clicando aqui.
  • Escolha a opção "Externo" e clique em "Criar"
  • Preencha um nome para o seu aplicativo. Sugestão: "No Boss Calendar"
  • Na seção "Escopos das APIs do Google", clique no botão "Adicionar escopo" para que possamos dar as permissões necessárias.
  • Marque as duas opções exibidas abaixo e depois clique em "Adicionar"
    • '../auth/calendar.events.readonly' (Ver as agendas)
    • '../auth/calendar.readonly' (Ver eventos em todas as suas agendas)
  • Na seção "Domínios autorizados" informe todos os domínios dos seus sites que utilizarão a extensão No Boss Calendar.
    • Ex: nobossextensions.com
  • Clique em "Salvar"

Crie agora as credenciais:

  • Acesse a página de credenciais do Google Calendar clicando aqui
  • Clique em "Criar credenciais" no topo da página e escolha a opção "ID do cliente do OAuth"
  • Na lista exibida para "Tipo de aplicativo", escolha a opção "Aplicativo da Web":
  • Informe um nome de identificação da sua credencial. Sugestão: "No Boss Calendar"
  • Na seção "URIs de redirecionamento autorizados" preencha a url informada dentro da modal de integrações do produto No Boss Calendar.
    • A url informada lá deve ser similar a http:/URL-MY-WEBSITE/administrator/index.php?option=com_nobossajax&library=noboss.src.Form.Field.Nbapiconnection.Nbapiconnectionhelper&method=generateToken&api=googlecalendar&format=raw
    • Após preenchido os dois valores acima, clique em "Criar".
  • Na modal exibida, copie para um bloco de notas os valores de "ID do cliente" e 'Chave secreta do cliente"
    • Esses dois valores serão os que você deverá cadastrar dentro da modal de integrações do produto Google Calendar.

Verificação da aplicação pelo Google:

  • Você já consegue utilizar a API sem solicitar a verificação da aplicação pelo Google.
  • Mas quando você mantem a aplicação sem verificação (status de publicação de "teste"), o token de acesso gerado na autenticação dentro da sua extensão irá durar apenas 7 dias.
  • Para realizar a solicitação de verificação, acesse nosso outro tutorial Publicação de aplicativo no Google Calendar API

Youtube

Introdução:

  • Apresentaremos aqui uma passo a passo simplificado. Para mais informações, você pode acessar a documentação do Google.
  • O requisito para criar as credenciais é você ter uma conta criada no Google, podendo ser uma conta gratuita ou paga.

Inicie ativando a API do Youtube em sua conta Google

  • Acesse a biblioteca de API's do Google clicando aqui e utilizando o seu login do Google.
  • Clique na opção "YouTube Data API v3"
  • Clique em "Ativar"

Crie um 'aplicativo' na conta do Google com permissões de acesso:

  • Acesse a página de "consentimento oAuth" do Youtube API clicando aqui.
  • Escolha a opção "Externo" e clique em "Criar"
  • Preencha um nome para o seu aplicativo. Sugestão: "No Boss Video Gallery"
  • Na seção "Escopos das APIs do Google", clique no botão "Adicionar escopo" para que possamos dar as permissões necessárias.
  • Marque a opção exibida abaixo e depois clique em "Adicionar"
    • '../auth/youtube.readonly' (Visualize sua conta do YouTube)
  • Na seção "Domínios autorizados" informe todos os domínios dos seus sites que utilizarão a extensão No Boss Video Gallery.
  • Clique em "Salvar"

Crie agora as credenciais:

  • Acesse a página de credenciais do Youtube API clicando aqui
  • Clique em "Criar credenciais" no topo da página e escolha a opção "ID do cliente do OAuth"
  • Na lista exibida para "Tipo de aplicativo", escolha a opção "Aplicativo da Web":
  • Informe um nome de identificação da sua credencial. Sugestão: "No Boss Video Gallery"
  • Na seção "URIs de redirecionamento autorizados" preencha a url informada na seção de integração do youtube na extensão dentro do Joomla.
    • A url informada lá deve ser similar a http:/URL-MY-WEBSITE/administrator/index.php?option=com_nobossajax&library=noboss.src.Form.Field.Nbapiconnection.Nbapiconnectionhelper&method=generateToken&api=youtube&format=raw
  • Após preenchido, clique em "Criar".
  • Na modal exibida, copie para um bloco de notas os valores de "ID do cliente" e 'Chave secreta do cliente"
    • Esses dois valores serão os que você deverá cadastrar nos campos de integrações da extensão no Joomla.

Verificação da aplicação pelo Google:

  • Você já consegue utilizar a API sem solicitar a verificação da aplicação pelo Google.
  • Mas quando você mantem a aplicação sem verificação (status de publicação de "teste"), o token de acesso gerado na autenticação dentro da sua extensão irá durar apenas 7 dias.
  • Para fazer a verificação da aplicação e evitar que o token funcione apenas por 7 dias, você deve editar novamente os dados do seu aplicativo na "Tela de consentimento OAuth" preenchendo mais informações do aplicativo (link da página inicial, link da página de política de privacidade) e depois clicar em "Enviar para verificação" seguindo os demais passos exibidos na tela.

Vimeo

Introdução

Inicie criando uma conta ou autenticando em uma conta existente

  • Acesse a url https://vimeo.com/ e clique em 'Inscreva-se' e se cadastre (caso não tenha conta) ou clique em 'Entrar' (caso já tenha uma conta).
    • A conta pode ser com plano gratuito ou pago. Não há requisito quanto ao tipo de plano

Crie um 'aplicativo' na conta do Vimeo

  • Estando já autenticado, acesse https://developer.vimeo.com/apps/new
  • Preencha os campos exibidos e após clique em 'Create App'
    • No campo 'Will people besides you be able to access your app?' você pode colocar 'No'.
  • Na tela seguinte, siga os passos abaixo:
    1. Copie o 'Client identifier' e salve em um bloco de notas para utilizar posteriormente na integração da extensão.
    2. Role a página até a seção 'Authentication' para configurar as credenciais
    3. Selecione a opção 'Authenticated (you)'
    4. Logo abaixo marque a opção 'Private'
    5. Clique no botão 'Generate'
    6. Mais para baixo em 'Manage App Secrets' copie o valor de 'Client Secrets' e guarde junto com o 'Client identifier' copiado anteriormente
      • Esses dois valores serão os que você deverá cadastrar nos campos de integrações da extensão no Joomla.
    7. Logo mais abaixo, na seção "Your callback URLs" clique em "Add URL" e preencha a url informada na seção de integração do Vimeo na extensão dentro do Joomla.
      • A url informada lá deve ser similar a http:/URL-MY-WEBSITE/administrator/index.php?option=com_nobossajax&library=noboss.src.Form.Field.Nbapiconnection.Nbapiconnectionhelper&method=generateToken&api=youtube&format=raw
    8. Logo abaixo, habilite a opção 'Implicit authentication'
    9. Pronto. Agora basta você informar os valores de 'Client Secrets' e 'Client identifier' na seção de integração do Vimeo dentro da extensão no Joomla.
Publicação anterior

Tradução de extensões usando site Transifex

Próxima publicação

Ajustando permissões de diretórios e arquivos no Joomla