Chaves de API, autenticação e o proxy
Alguns mapas base e camadas vêm de serviços que exigem uma chave ou uma entrada com credenciais. Esta página explica onde essas credenciais são informadas, como são armazenadas e o que o proxy do Icon Map faz quando um servidor não permite que o Power BI o leia.
Inserir uma chave de API
- Selecione o visual e abra Painel Formato > Chaves de API e autenticação > Chaves de API.
- Cole a chave na caixa do fornecedor.
- Escolha o fornecedor como mapa base ou ative a camada que o usa.
Chaves de API
| Configuração | Usada para | Padrão |
|---|---|---|
| Azure Maps | Mapas base do Azure Maps | Vazio |
| Mappable | Mapas base da Mappable | Vazio |
| Ordnance Survey | Mapas base da Ordnance Survey | Vazio |
| Open Weather Map | A camada de referência Clima | Vazio |
| Google Maps, Mapbox, Map Tiler | Mapas base que fazem parte do mecanismo Herdado. Consulte a documentação da versão 1.1.0.9 e anteriores | Vazio |
O grupo começa com a nota "Consulte a seção Autenticação do ArcGIS para a chave de API do ArcGIS". O ArcGIS tem o seu próprio grupo, descrito a seguir.
Qual fornecedor precisa de qual chave é explicado em Outros fornecedores de mapa base e em Clima, trânsito e luz do dia. Os mapas base do Icon Map não precisam de chave.
Autenticação do ArcGIS
O grupo Autenticação do ArcGIS define como o mapa se conecta ao ArcGIS Online ou ao ArcGIS Enterprise. O guia completo, com as etapas de cada método, é Conectar ao ArcGIS. Em resumo:
| Tipo de autenticação | Quem entra | O que é salvo no relatório |
|---|---|---|
| Chave de API | Ninguém | A chave de API |
| OAuth2 (ID e segredo do cliente) | Ninguém. Um aplicativo registrado na sua organização do ArcGIS se conecta | O ID do cliente e o segredo do cliente, em forma protegida |
| Nome de usuário e senha | Cada pessoa, em uma janela de entrada do Power BI | Nada. A sessão é mantida no armazenamento local do visual no dispositivo dessa pessoa |
Enviar credencial como define como a credencial viaja até o ArcGIS: Parâmetro de URL (padrão) ou Cabeçalho de autorização (Bearer). Deixe em Parâmetro de URL, a menos que o seu servidor o rejeite. O ArcGIS Enterprise 11.5 e posteriores podem rejeitar chaves de API mais novas na URL com "Invalid Token". Esses servidores precisam da opção Cabeçalho de autorização e devem permitir o cabeçalho Authorization nas suas configurações de CORS.
Sem credencial, o conteúdo do ArcGIS é lido como conteúdo público.
Como as credenciais são armazenadas
- As chaves de API são salvas no relatório como configurações comuns. Qualquer pessoa que possa editar o relatório pode lê-las, e o visual envia cada chave ao seu próprio fornecedor quando solicita tiles. Restrinja as chaves no fornecedor sempre que puder, por exemplo aos serviços que o mapa usa.
- O Segredo do cliente do ArcGIS é salvo em forma protegida e mostrado como pontos depois que você o insere.
- As sessões de uma entrada pessoal no ArcGIS são mantidas no armazenamento local do visual no dispositivo do leitor, e não no relatório. Isso exige que o seu locatário do Power BI permita o armazenamento local para visuais personalizados.
- A chave de licença do Icon Map, quando é usada, é salva no relatório em Icon Map Pro > Chave de licença (para licenciamento não baseado em usuário). Consulte Chaves de licença e ativação.
O proxy
Por que existe um proxy
O Power BI executa cada visual personalizado em um quadro isolado (sandbox). Um servidor Web precisa permitir explicitamente as solicitações vindas desse quadro, por meio de cabeçalhos CORS, para que o visual possa ler a resposta. A maioria dos serviços públicos de mapas permite. Alguns servidores não permitem, em geral servidores ArcGIS Enterprise e alguns servidores de tiles, GeoJSON e WFS. Uma camada de um servidor assim fica em branco, embora o mesmo link abra em um navegador.
A correção que mantém tudo sob o seu controle é permitir o CORS no seu servidor. Quando isso não é possível, o proxy do Icon Map pode buscar o recurso em nome do visual e devolvê-lo com os cabeçalhos de que o Power BI precisa.
O proxy é um serviço de retransmissão operado pelo Icon Map em proxy.icon-map.com. Ele vem desativado por padrão. Exige uma chave de licença do Icon Map, e as solicitações que passam pelo proxy podem consumir créditos de uso adicionais.
Quando o proxy é usado
Nesta versão, o proxy está disponível somente para camadas de referência WMS.
| Configuração | Onde | O que faz |
|---|---|---|
| Usar proxy CORS | O grupo de configuração de uma camada de referência WMS | Envia todas as solicitações dessa camada WMS pelo proxy do Icon Map. Ative se o seu servidor WMS não der suporte a solicitações CORS |
O que é enviado ao proxy
Nada é enviado ao proxy a menos que uma opção de proxy esteja ativada, com uma exceção descrita em "Camadas WMS que usam OAuth 2.0", abaixo.
Para abrir uma sessão, o visual envia:
- a chave de licença do Icon Map do cartão Icon Map Pro
- o ambiente em que o relatório está sendo executado (por exemplo, o Power BI Desktop, o serviço do Power BI ou o Power BI Embedded)
- o nome do produto
- a Referência opcional do cartão Icon Map Pro
- o ID da instância do visual e um ID de sessão
O proxy responde com um token de sessão de curta duração, que o visual reutiliza até pouco antes de expirar.
Para cada solicitação que passa pelo proxy, o visual envia:
- o endereço completo do recurso, incluindo a cadeia de consulta. Um token ou uma chave que faça parte do endereço viaja com ele
- o token de sessão
- quaisquer cabeçalhos de solicitação extras de que o servidor precise, por exemplo um cabeçalho de autorização
O proxy faz a solicitação ao seu servidor e devolve a resposta, incluindo conteúdo binário, como tiles. Em uma camada WMS, se não for possível abrir uma sessão, o visual envia a chave de licença e os detalhes da sessão em cada solicitação, no lugar de um token de sessão.
O que isso significa:
- O serviço de proxy vê o endereço de cada solicitação que passa por ele, qualquer credencial anexada a ela e a resposta.
- As linhas dos seus dados do Power BI não são enviadas por esse mecanismo. Somente as solicitações de camadas e de tiles são. Se você montar o link ou o filtro de uma camada a partir dos seus dados com a formatação condicional, os valores desse link fazem parte do endereço.
- O seu servidor precisa ser acessível pela internet para que o proxy possa buscar nele. O proxy não alcança um servidor que só está disponível dentro da sua rede.
Camadas WMS que usam OAuth 2.0
Quando uma camada de referência WMS tem o Tipo de autenticação definido como OAuth 2.0, o visual solicita o token de acesso por meio do serviço de proxy do Icon Map, esteja Usar proxy CORS ativado ou não. Essa solicitação contém a URL do OAuth2, o ID do cliente, o segredo do cliente e o escopo que você inseriu para a camada, junto com a chave de licença e os detalhes da sessão listados acima. Consulte Tiles raster, WMTS e WMS.
Dicas e limites
- Prefira corrigir o CORS no seu próprio servidor. Isso evita o proxy, a exigência de chave de licença e o salto extra.
- Um link que abre em um navegador, mas não no mapa, é o sinal habitual de um bloqueio de CORS. Consulte Solução de problemas.
- O proxy não torna público um servidor privado. Ele encaminha as credenciais que o seu mapa já usa.
- Se a sua rede restringe o tráfego de saída, permita os endereços do fornecedor e do Icon Map listados em Ambientes compatíveis e limites.