Render - Get Copyright Caption

Referência

Service:: Maps

API Version:: 1.0

Utilize para obter informações sobre direitos de autor para utilizar ao compor um mosaico.

Nota

descontinuação do serviço Azure Maps Render v1

O serviço Azure Maps Render v1 foi preterido e será descontinuado a 17/09/26. Para evitar interrupções de serviço, todas as chamadas à API Render v1 terão de ser atualizadas para utilizar a API Render v2 até 17/09/26.

A API de Direitos de Autor foi concebida para servir informações de direitos de autor para o serviço Mosaico de Composição. 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 do pedido de mapa, pode-se receber legendas para apresentar as informações do fornecedor de mapas no mapa.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
format	path	True	ResponseFormat	Formato pretendido da resposta. O valor pode ser json ou xml.
api-version	query	True	string	Número da versão da API Azure Maps.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-id		string	Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Microsoft Entra ID. Representa um ID exclusivo para a conta Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Microsoft Entra ID segurança no Azure Maps veja os seguintes artigos para obter orientações.

Respostas

Name	Tipo	Description
200 OK	CopyrightCaption	OK
Other Status Codes	ErrorResponse	Ocorreu um erro inesperado.

Segurança

AADToken

Estes são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do 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 APIs REST.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso 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 Azure Maps recurso a que a aplicação está a pedir acesso. Isto pode ser adquirido na API de gestão de Mapas.

O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações de Microsoft Entra ID. * O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

Para obter mais informações sobre plataforma de identidades da Microsoft, consulte plataforma de identidades da Microsoft descrição geral.

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 é aprovisionada quando Cria uma conta Azure Maps no portal do Azure ou com o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com esta chave, qualquer aplicação pode aceder a toda a API REST. Por outras palavras, esta chave pode ser utilizada como uma chave mestra na conta na qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar a abordagem de aplicações cliente confidenciais para aceder Azure Maps APIs REST 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 recurso de Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado 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 de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.

Type: apiKey
In: header

Exemplos

Successful Copyright Caption Request

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

Definições

Name	Description
CopyrightCaption	Este objeto é devolvido a partir de uma chamada de direitos de autor com êxito
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
ResponseFormat	Formato pretendido da resposta. O valor pode ser json ou xml.

CopyrightCaption

Este objeto é devolvido a partir de uma chamada de direitos de autor com êxito

Name	Tipo	Description
copyrightsCaption	string	Propriedade Legenda de Direitos de Autor
formatVersion	string	Propriedade Formatar Versão

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ResponseFormat

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

Name	Tipo	Description
json	string	O Formato de Intercâmbio de Dados de Notação de Objetos JavaScript
xml	string	O Idioma de Marcação Extensível

Share via