Render - Get Copyright Caption

Aplica-se a: consulte os tipos de preços.

A API de direitos autorais foi projetada para fornecer informações de direitos autorais para o serviço renderizar bloco. Além dos direitos autorais básicos para todo o mapa, a API está atendendo grupos específicos de direitos autorais para alguns países.

Como alternativa aos direitos autorais para solicitação de mapa, é possível receber legendas para exibir as informações do provedor de mapa no mapa.

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

Parâmetros de 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 API de Mapas Azure.

Cabeçalho da solicitação

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

Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança Azure AD. Ele representa uma ID exclusiva para a conta Azure Mapas e pode ser recuperada da API de Conta do plano de gerenciamento Azure Mapas. Para usar Azure AD segurança no Azure Mapas consulte os artigos a seguir para obter diretrizes.

Respostas

Name Type Description
200 OK

OK

Other Status Codes

Erro inesperado.

Segurança

AADToken

Estes são os Fluxos OAuth2 do Azure Active Directory . Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. Qualquer usuário, grupo ou entidade de serviço pode ter acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para Azure Mapas APIs REST.

Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de acessar o controle em APIs e escopos específicos.

Observações

  • Essa definição de segurança requer o uso do x-ms-client-id cabeçalho para indicar a qual recurso Azure Mapas o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento do Mapas.

O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações do Azure Active Directory. * O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * O uso do SDK da Web Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

  • Atualmente, o Azure Active Directory v1.0 ou v2.0 dá suporte a Trabalho, Escola e Convidados, mas não dá suporte a 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

Essa é uma chave compartilhada que é provisionada quando você cria uma conta Azure Mapas no portal do Azure ou usando o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta na qual elas são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de aplicativos cliente confidenciais para acessar Azure Mapas APIs REST para que sua chave possa ser armazenada com segurança.

Type: apiKey
In: query

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação sas de lista no recurso Azure Mapas por meio do plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado à expiração, taxa e região(s) de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de forma mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no recurso de conta de mapa 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

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

ErrorAdditionalInfo

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

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

ResponseFormat

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

CopyrightCaption

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

Name Type Description
copyrightsCaption
  • string

Propriedade Copyrights Caption

formatVersion
  • string

Propriedade Format Version

ErrorAdditionalInfo

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

Name Type Description
info
  • object

As informações adicionais.

type
  • string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Type Description
additionalInfo

As informações adicionais do erro.

code
  • string

O código de erro.

details

Os detalhes do erro.

message
  • string

A mensagem de erro.

target
  • string

O destino 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 intercâmbio de dados de notação de objeto JavaScript

xml
  • string

A linguagem de marcação extensível