Render - Get Copyright Caption

Serviço:

Maps

Versão da API:

2024-04-01

Use para obter informações de direitos autorais para usar ao renderizar um bloco.
A API Get Copyright Caption é uma solicitação HTTP GET projetada para fornecer informações de direitos autorais a serem usadas com blocos solicitados do serviço de renderização. Além de um copyright básico para todo o mapa, ele pode servir grupos específicos de direitos autorais para alguns países / regiões.

Como alternativa aos direitos autorais para solicitação de mapa, ele também pode retornar legendas para exibir informações do provedor no mapa.

GET {endpoint}/map/copyright/caption/{format}?api-version=2024-04-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string
format	path	True	ResponseFormat	Formato desejado da resposta. O valor pode ser json ou xml.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-id		string	Indica a conta destinada a ser utilizada com o modelo de segurança do Microsoft Entra ID. Este ID único para a conta Azure Maps pode ser obtido a partir da API da conta Azure Maps plano de gestão. Para mais informações sobre o uso da segurança Microsoft Entra ID em Azure Maps, consulte Gerir autenticação em Azure Maps.

Respostas

Name	Tipo	Description
200 OK	CopyrightCaption	O pedido foi bem-sucedido.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

AadToken

Estes são os fluxos Microsoft Entra OAuth 2.0. Quando combinado com controlo Azure baseado em funções, pode ser usado para controlar o acesso a APIs REST Azure Maps. Os controlos de acesso baseados em papéis do Azure são usados para designar o acesso a uma ou mais contas ou subrecursos de recursos do Azure Maps. Qualquer utilizador, grupo ou principal de serviço pode receber acesso através de um papel incorporado ou de um papel personalizado composto por uma ou mais permissões para Azure Maps APIs REST.\n\nPara implementar cenários, recomendamos consultar conceitos autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações(ões) através de objetos capazes de controlo de acesso em APIs e escopos específicos.\n\n#### Notas\n* Esta definição de segurança exige a utilização do cabeçalho x-ms-client-id para indicar a que Azure Maps recurso a aplicação está a pedir acesso. Isto pode ser adquirido da API de gestão Maps.\n* \nO Authorization URL é específico para a instância Azure cloud pública. As clouds soberanas têm URLs de Autorização e configurações de Microsoft Entra ID únicas. \n* \nO controlo de acesso Azure baseado em funções é configurado a partir do plano de gestão Azure via portal Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.\n* \nUtilização do Azure Maps Web SDK permite a configuração de uma aplicação para múltiplos casos de uso.\n* Para mais informações sobre plataforma de identidades da Microsoft, consulte plataforma de identidades da Microsoft visão geral.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

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

subscription-key

Esta é uma chave partilhada que é provisionada quando Cria uma conta Azure Maps no portal Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.\n\n Com esta chave, qualquer aplicação pode aceder a toda a API REST. Ou seja, esta chave pode ser usada como chave mestra na conta onde são emitidas.\n\n Para aplicações expostas publicamente, a nossa recomendação é usar a abordagem confidenciais de aplicações cliente para aceder às APIs REST Azure Maps para que a sua chave possa ser armazenada de forma segura.

Tipo: apiKey
Em: header

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação List SAS no recurso Azure Maps através do plano de gestão Azure via portal Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.\n\n Com este token, qualquer aplicação está autorizada a aceder com Azure controlos de acesso baseados em funções e controlo minucioso da expiração, taxa e região(s) de utilização para o token em questão. Por outras palavras, o Token SAS pode ser usado para permitir que aplicações controlem o acesso de forma mais segura do que a chave partilhada.\n\n Para aplicações publicamente expostas, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta Map para limitar abusos de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Successful Copyright Caption Request

Pedido de amostra

HTTP

GET {endpoint}/map/copyright/caption/json?api-version=2024-04-01

Resposta da amostra

Código de estado:

200

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

Definições

Name	Description
CopyrightCaption	Este objeto é retornado de uma chamada de direitos autorais bem-sucedida
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro comum para todas as APIs do Azure Resource Manager devolver detalhes de erro para operações falhadas. (Isso também segue o formato de resposta de erro OData.)
ResponseFormat	Formato desejado da resposta. O valor pode ser json ou xml.

CopyrightCaption

Object

Este objeto é retornado de uma chamada de direitos autorais bem-sucedida

Name	Tipo	Description
copyrightsCaption	string	Propriedade Copyrights Caption
formatVersion	string	Propriedade Format Version

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Object

Resposta de erro comum para todas as APIs do Azure Resource Manager devolver detalhes de erro para operações falhadas. (Isso também segue o formato de resposta de erro OData.)

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ResponseFormat

Enumeração

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

Valor	Description
json	O formato de intercâmbio de dados de notação de objeto JavaScript
xml	A linguagem de marcação extensível