Render - Get Copyright Caption

Aplica-se a: ver níveis de preços.

Direitos autorais A API foi concebida para servir informações de direitos autorais para o serviço Render Tile. Além dos direitos de autor básicos para todo o mapa, a API está a servir grupos específicos de direitos de autor para alguns países.

Como alternativa aos direitos de autor para pedido de mapa, pode-se receber legendas para exibir as informações do fornecedor do mapa no mapa.

GET https://atlas.microsoft.com/map/copyright/caption/{format}?api-version=1.0

Parâmetros do URI

Name In Required Type Description
format
path True

Formato desejado da resposta. O valor pode ser json ou xml.

api-version
query True
  • string

Número de versão da Azure Maps API.

Cabeçalho do Pedido

Name Required Type Description
x-ms-client-id
  • string

Especifica qual a conta destinada a ser utilizada em conjunto com o modelo de segurança Azure AD. Representa um ID único para a conta Azure Maps e pode ser recuperado a partir do plano de gestão Azure Maps Conta API. Para utilizar Azure AD segurança em Azure Maps consulte os seguintes artigos para orientação.

Respostas

Name Type Description
200 OK

OK

Other Status Codes

Ocorreu um erro inesperado.

Segurança

AADToken

Estes são os Fluxos OAuth2 Do Diretório Ativo Azure . Quando emparelhado com o controlo de acesso baseado em funções Azure, pode ser usado para controlar o acesso a AZURE MAPS APIs REST. Os controlos de acesso baseados em funções Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps REST APIs.

Para implementar cenários, recomendamos visualização de conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para aplicações de modelação através de objetos capazes de aceder ao controlo em APIs e âmbitos específicos.

Notas

  • Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que recurso Azure Maps a aplicação está a solicitar acesso. Isto pode ser adquirido pela API de gestão maps.

O Authorization URL é específico para o exemplo de nuvem pública Azure. As nuvens soberanas têm URLs de Autorização únicos e configurações de diretório Azure Ative. * O controlo de acesso baseado em funções Azure é configurado a partir do plano de gestão Azure através de portal do Azure, PowerShell, CLI, Azure SDKs ou REST APIs. * A utilização do Azure Maps Web SDK permite a configuração baseada na configuração de uma aplicação para múltiplos casos de uso.

  • Atualmente, o Azure Ative Directory v1.0 ou v2.0 apoia o Trabalho, a Escola e os Hóspedes, mas não suporta contas pessoais.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Esta é uma chave partilhada que é a provisionada quando cria uma conta Azure Maps no portal do Azure ou utilizando PowerShell, CLI, Azure SDKs ou REST API.

Com esta chave, qualquer aplicação pode aceder a toda a API REST. Por outras palavras, esta chave pode ser usada como chave principal na conta em que são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar a abordagem de aplicações confidenciais do cliente para aceder Azure Maps REST APIs para que a sua chave possa ser armazenada de forma segura.

Type: apiKey
In: query

SAS Token

Este é um token de assinatura de acesso partilhado é criado a partir da operação List SAS no Azure Maps recurso através do plano de gestão Azure via portal do Azure, PowerShell, CLI, Azure SDKs ou REST APIs.

Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções Azure e controlo de grãos finos à expiração, taxa e(s) de utilização para o token específico. Por outras palavras, o Sas Token pode ser usado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.

Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta Map para limitar o abuso de renderização e renovar regularmente o Token SAS.

Type: apiKey
In: header

Exemplos

Sample Request

GET https://atlas.microsoft.com/map/copyright/caption/json?api-version=1.0

Sample Response

{
  "formatVersion": "0.0.1",
  "copyrightsCaption": "© 1992 - 2017 TomTom."
}

Definições

CopyrightCaption

Este objeto é devolvido de uma chamada de direitos autorais bem sucedida

ErrorAdditionalInfo

O erro de gestão de recursos informações adicionais.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

ResponseFormat

Formato desejado da resposta. O valor pode ser json ou xml.

CopyrightCaption

Este objeto é devolvido de uma chamada de direitos autorais bem sucedida

Name Type Description
copyrightsCaption
  • string

Propriedade legendagem de direitos autorais

formatVersion
  • string

Propriedade versão de formato

ErrorAdditionalInfo

O erro de gestão de recursos informações adicionais.

Name Type Description
info
  • object

A informação adicional.

type
  • string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Type Description
additionalInfo

A informação adicional do erro.

code
  • string

O código de erro.

details

Os detalhes do erro.

message
  • string

A mensagem de erro.

target
  • string

O alvo do erro.

ErrorResponse

Resposta de erro

Name Type Description
error

O objeto de erro.

ResponseFormat

Formato desejado da resposta. O valor pode ser json ou xml.

Name Type Description
json
  • string

O formato de troca de dados de notação de objeto javaScript

xml
  • string

A linguagem de marcação extensível