Como realizar o cadastro de Chave de API Google no Petroshow?

OBJETIVO

Essa documentação tem por objetivo disponibilizar ao usuário, as instruções e orientações quanto a configuração da Chave de API Google, para utilização do Mapa nos módulos Gerencial e VendasWeb.

DESCRIÇÃO DA ROTINA/PROCESSO

Sobre a Chave de API:

O que é a Chave de API?

API é a sigla americana utilizada para Application Programming Interface ou, em português, Interface de Programação de Aplicativos.

Tanto a Google como outras empresas provedoras de APIs utilizam chaves para identificar e rastrear as requisições e, assim, mensurar o quanto a aplicação utiliza de seus serviços.

Sendo assim, as Chaves de API são as credenciais de acesso que autorizam o uso de funcionalidades específicas da API e ajudam a evitar que esta seja usada de forma indevida, identificando sua permissão e compartilhando os dados necessários, com isso, o servidor pode bloquear requisições feitas acima do normal associadas àquela Chave de API.

Fonte: Do You Know What is API Keys: Do You Know What Is??

Quanto custa obter uma chave de API do Google Maps?

A partir de 16 de julho 2019, os usuários passaram a ter a limitação de até 28.000 exibições gratuitas de mapas por mês, com a cobrança de cada 1.000 exibições subsequentes no valor de US$ 7,00.

Essas 28.000 consultas gratuitas, representam um crédito de US$ 200 mensais que a plataforma do Google disponibiliza para o uso em seus produtos.

Para saber o custo de cada serviço, o usuário poderá acessar a tabela de preços do Google e estimar o valores para cada faixa de utilização.

Como Obter uma Chave de API do google Maps:

Passo 1: Conta Google:

Para obtenção da Chave de API Google, é obrigatório que o usuário possua uma conta google para realizar o login na sua conta do Gmail. Caso ainda não possua uma conta cadastrada, você pode criá-la gratuitamente clicando no link Criar sua Conta do Google.

Passo 2: Painel do Console de APIs do Google:

Em seguida, já com o login efetuado na conta de gmail, o usuário deverá acessar o painel do Console de APIs do Google. Onde o mesmo irá visualizar uma tela semelhante a da imagem abaixo:

Passo 3: Projeto:

O usuário só poderá obter uma API key do Google Maps, se tiver um projeto na plataforma. Se o mesmo já tiver criado algum, aparecerão duas opções no lado direito da tela: SELECIONAR e CRIAR. Caso ainda não tenha nenhum, aparecerá apenas a opção CRIAR PROJETO, na qual deverá clicar, conforme print abaixo:

Feito isso, a plataforma irá abrir a tela de criação, onde basta atribuir um nome ao seu projeto. É importante que este nome esteja relacionado à função que será atribuída a ele, a fim de facilitar sua identificação em meio a outros projetos que possam ser incluídos posteriormente. Após inserir o nome, basta clicar em CRIAR:

Passo 4: Credenciais

Após a criação do projeto, é necessário realizar a criação das credenciais para poder acessar as API’s. Para isto basta clicar no botão CRIAR CREDENCIAIS:

E Em seguida, selecionar primeiro opção, Chave de API:

Ao selecionar esta opção, irá abrir uma nova janela com a sua Chave de API:

Nesta tela, o google disponibiliza duas opções de aplicação da API: A opção RESTRINGIR CHAVE onde o usuário poderá renomear sua API Key e aplicar as restrições necessárias de acordo com o uso que irá fazer dela. E a opção FECHAR, para o caso de não querer aplicar nenhuma restrição.

Feito isso, a Chave API está criada, e o usuário já pode copiá-la!

Passo 5: Ativação da Chave API do Google Maps:

Após realizar a criação das credenciais, o próximo passo de como obter uma chave de API do Google Maps é selecionar a API que você deseja usar. Para isso, basta acessar a Biblioteca, no menu do lado esquerdo da página:

O usuário pode navegar pela página ou então utilizar o campo de busca para pesquisar pela API que deseja:

Ao selecionar API desejada, o usuário será redirecionado para uma página contendo especificações gerais sobre ela, além de tutoriais, termos de serviço, documentação, e também os detalhes referentes ao valor a ser cobrado caso você ultrapasse o limite de $200 dólares em créditos mensais concedidos a todas as contas:

Para ativá-la, basta clicar no botão azul, onde no botão ATIVAR, e você será redirecionado para o painel da API, onde pode acompanhar as métricas de uso.

Vale ressaltar que para o funcionamento dos mapas no módulo PS - Gerencial é necessário ativar a API Geocoding API, e nos módulos PS - Gerencial e VendasWeb, é necessário habilitar a API Mapa JavaScript API:

É importante ressaltar que nas contas usuais do google é necessário informar uma forma de Faturamento para que a API funcione corretamente e não ocorram erros na visualização dos Mapas. Para isso, o usuário deverá acessar console do Google Cloud Platform e adicionar uma conta de faturamento ao seu projeto.

Configuração no Sistema

Para configurar a Chave API no sistema, o usuário deve acessar a rotina PS - Gerencial >> Cadastros Específicos >> Estabelecimento>> Configuração ou pelo atalho Ctrl + O.

Após selecionada a rotina, na secção Configurações Gerais, na opção Dados Cadastrais, basta o usuário informar no campo Código API Google, o código da API do Google que será utilizada no sistema, e salvar () a alteração em seguida:

Feito isso, o processo de geração e configuração de API Google, estará finalizado!

RESULTADOS ESPERADOS

A realização geração e da configuração das API’s Google, para posterior utilização dos seus recursos no sistema.

VERSÃO DO SISTEMA DOCUMENTADO

Versão 2008.1003