Chaves de API
Crie a chave que liga o seu site ou software ao Measure Map Online, escolha o que ela pode fazer, mantenha separados o trabalho real e os testes, e substitua-a ou restrinja-a com segurança.
Uma chave de API permite que o seu próprio site ou software trabalhe com a sua conta do Measure Map Online: mostrar o mapa de um projeto no seu site, iniciar projetos para os seus visitantes, ou ler e alterar projetos através da API REST. Cria e gere as chaves na página Developer.
Abrir a página Developer#
No menu do painel, em Avançado, prima Developer. Abre em Chaves de API, e as outras secções aparecem listadas por baixo no menu (num telemóvel, como separadores no topo da página):
- Ligação de convidado (Open Guest): a ligação sem código para o seu site. Consulte Open Guest.
- Experimentar a API, Webhooks e API REST: consulte a referência da API.
- Incorporar um mapa (Enterprise): consulte a API iFrame.
O indicador no topo do cartão da chave diz se a sua chave está Ativo, Não ativado (ainda sem chave), Desativado (acesso à API suspenso: nenhuma chave funciona e não é possível criar outra até o suporte levantar a suspensão) ou Expirado (a subscrição não está ativa).
Produção e testes#
No topo do cartão da chave, alterne entre Produção e Testes. Cada um tem a sua própria chave, e a página mostra a que escolher. A escolha aplica-se também em Experimentar a API, e mantém-se enquanto navega entre as secções. Incorporar um mapa e Ligação de convidado usam sempre a sua chave de produção, porque os visitantes do seu site só conseguem abrir projetos de produção: abrir qualquer uma delas faz a página voltar a Produção.
- Produção é a sua conta real, e a página abre nela. Use uma chave de produção no seu site.
- Testes serve para construir e testar uma integração. Os projetos, as pastas e os produtos criados com uma chave de testes ficam separados dos reais: uma chave de produção não os vê, e uma chave de testes não vê os de produção. Os pedidos feitos com uma chave de testes não contam para os seus valores de utilização, e os projetos de convidados criados com uma nunca são faturados.
Criar uma nova chave de testes nunca afeta a sua chave de produção, e vice-versa.
Escolher o que a chave pode fazer#
Em Acesso da nova chave, cada linha é uma área da API. Escolha até onde a próxima chave que criar chega nela:
| Área | Opções | O que permite |
|---|---|---|
| Mapas incorporados | Sem acesso, Permitido | Autenticar um visitante num mapa incorporado. A maioria das integrações só precisa disto. |
| Projetos | Sem acesso, Ler, Ler e alterar | Projetos e pastas, com as suas medições, comentários e exportações. |
| Usuários (Enterprise) | Sem acesso, Ler, Ler e alterar | As pessoas da sua conta e os respetivos lugares. |
| Produtos | Sem acesso, Ler, Ler e alterar | O seu catálogo de produtos e os respetivos preços. |
Mantenha o ponteiro sobre uma opção para ver exatamente o que concede. A sua primeira chave começa só com Mapas incorporados, que é tudo o que um mapa incorporado precisa; uma chave que substitui outra começa com o acesso dessa chave. Escolha pelo menos uma área. Iniciar sessão como um dos membros da sua organização através da API requer Usuários: Ler e alterar, e não Mapas incorporados.
O que uma chave pode fazer fica fixo quando a cria. Para dar mais ou menos acesso a uma chave, crie uma nova.
Criar uma chave#
- Escolha Produção ou Testes.
- Defina o acesso em Acesso da nova chave.
- Se quiser, escreva um nome em Nome da nova chave (opcional), para distinguir as suas chaves.
- Prima Gerar nova chave.
A chave aparece em A sua chave de API, oculta exceto os primeiros e os últimos caracteres, com uma linha Permissões que indica o que pode fazer. Prima para a ver por inteiro, ou para copiar a chave completa. Recebe um e-mail sempre que é criada uma chave na sua conta.
Uma chave criada antes de existirem áreas de acesso pode fazer tudo exceto trabalhar com produtos e iniciar sessão como um membro; o cartão avisa-o disso. Substitua-a por uma mais restrita se só a usar para incorporações.
Substituir uma chave#
Prima de novo Gerar nova chave quando já tem uma chave. A aplicação avisa-o primeiro: Será criada uma nova chave e a atual continuará a funcionar durante 24 horas, para que possa atualizar os sites que a utilizam. Pode revogá-la mais cedo quando terminar.
A chave antiga passa para Chaves anteriores, com o tempo que lhe resta e quando foi usada pela última vez. Ainda aceites enquanto implementa a nova chave. Revogue-a assim que nada a estiver a usar. Para a parar de imediato, prima Revogar e confirme; qualquer site que ainda a use deixa de funcionar de imediato. Recebe um e-mail quando uma chave é revogada.
As restrições de sites são copiadas para a nova chave. Pode criar uma nova chave cerca de uma vez por minuto.
Restringir a chave aos seus sites#
Somente os sites desta lista podem usar sua chave em um navegador: mapas incorporados e requisições de páginas de qualquer outro site são recusados. Chamadas feitas de um servidor não são afetadas.
- Em Restrições do site, escreva o seu site em
Digite um website ou domínio: um domínio como
example.com, um endereço IP oulocalhost. Pode colar um endereço completo: só é guardado o nome do site, semhttps://, o caminho ou a porta. - Prima Adicionar.
Um domínio abrange também os seus subdomínios: example.com permite
shop.example.com. Prima para retirar um site e
confirme; depois de retirar o último, a chave funciona a partir de qualquer
site. Recebe um e-mail sempre que um site é retirado de uma chave.
A lista aplica-se aos navegadores. Um mapa incorporado só abre numa página de um site da lista; se o navegador não indicar em que página está, é recusado. Um pedido à API REST enviado a partir de uma página web tem de vir de um site da lista. Um pedido a partir do seu próprio servidor não indica nenhum site e não é verificado. O próprio Measure Map Online é sempre permitido, para que as pré-visualizações desta página continuem a funcionar.
Ver como a chave é usada#
Utilização soma todas as suas chaves de produção, por isso os valores continuam quando substitui uma chave. Mostra os pedidos dos últimos 30 dias, tanto de mapas incorporados como da API REST, com uma barra por dia; o total Desde sempre; o Último acesso; quando a chave atual foi criada (Chave criada); e os Domínios principais: os sites que mais usam as suas chaves. Um site que não reconheça aí é um motivo para restringir ou substituir a chave.
Os pedidos de testes não contam, por isso os valores só aparecem em Produção. Também não contam os pedidos que esta própria página faz, em Experimentar a API e nas pré-visualizações.
Manter a sua chave segura#
- Dê a cada chave apenas o acesso de que precisa. Uma chave numa página web (por exemplo no endereço de uma incorporação) deve ter só Mapas incorporados.
- Esta chave pode alterar os seus dados. Guarde-a no seu servidor, nunca numa página web ou aplicação.
- Restrinja aos seus próprios sites uma chave usada em páginas web.
- Deixe a chave oculta na página quando partilhar o ecrã; para a copiar não é preciso mostrá-la.
- Se uma chave puder ter sido divulgada, crie uma nova e revogue de imediato a antiga em Chaves anteriores.
- Construa e teste com uma chave de Testes, para que as experiências nunca vão parar aos seus projetos reais.
Ainda precisa de ajuda?
Escreva à nossa equipa de suporte e diga-nos o que estava a tentar fazer. As capturas de ecrã ajudam.