Render - Get Copyright Caption

Se aplica a:consulte planes de tarifa.

Copyrights API está diseñado para proporcionar información de copyright para el servicio Render Tile. Además de los derechos de autor básicos para todo el mapa, la API sirve a grupos específicos de derechos de autor para algunos países.

Como alternativa a los derechos de autor de la solicitud de mapa, se pueden recibir subtítulos para mostrar la información del proveedor del mapa en el mapa.

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

Parámetros de identificador URI

Name In Required Type Description
format
path True

Formato deseado de la respuesta. El valor puede ser json o xml.

api-version
query True
  • string

Número de versión de la API de Azure Maps.

Encabezado de la solicitud

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

Especifica qué cuenta está pensada para su uso junto con el modelo de seguridad de Azure AD. Representa un identificador único para la cuenta de Azure Maps y se puede recuperar de la API de cuenta del plano de administración de Azure Maps. Para usar la seguridad de Azure AD en Azure Maps consulte los siguientes artículos para obtener instrucciones.

Respuestas

Name Type Description
200 OK

OK

Other Status Codes

Se ha producido un error inesperado.

Seguridad

AADToken

Estos son los flujos de OAuth2 de Azure Active Directory . Cuando se empareja con el control de acceso basado en rol de Azure, se puede usar para controlar el acceso a Azure Maps API REST. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias Azure Maps cuenta de recursos o subrecursos. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio a través de un rol integrado o un rol personalizado compuesto por uno o varios permisos para Azure Maps API REST.

Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Notas

  • Esta definición de seguridad requiere el uso del x-ms-client-id encabezado para indicar a qué recurso Azure Maps la aplicación solicita acceso. Esto se puede adquirir desde la API de administración de Maps.

Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de Azure Active Directory. * El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST. * El uso del SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.

  • Actualmente, Azure Active Directory v1.0 o v2.0 admite Work, School e Invitados, pero no admite cuentas personales.

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

Se trata de una clave compartida que se aprovisiona al crear una cuenta de Azure Maps en el Azure Portal o mediante PowerShell, la CLI, los SDK de Azure o la API REST.

Con esta clave, cualquier aplicación puede acceder a todas las API REST. En otras palabras, esta clave se puede usar como clave maestra en la cuenta en la que se emiten.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es usar el enfoque de aplicaciones cliente confidenciales para acceder a Azure Maps API REST para que la clave se pueda almacenar de forma segura.

Type: apiKey
In: query

SAS Token

Se crea un token de firma de acceso compartido a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.

Con este token, cualquier aplicación está autorizada para acceder a los controles de acceso basado en rol de Azure y el control específico a la expiración, la tasa y las regiones de uso para el token determinado. En otras palabras, el token de SAS se puede usar para permitir que las aplicaciones controlen el acceso de forma más segura que la clave compartida.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de la cuenta de asignación para limitar la representación del abuso y renovar periódicamente el token de SAS.

Type: apiKey
In: header

Ejemplos

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."
}

Definiciones

CopyrightCaption

Este objeto se devuelve de una llamada correcta a copyright.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

ErrorDetail

Detalle del error.

ErrorResponse

Respuesta de error

ResponseFormat

Formato deseado de la respuesta. El valor puede ser json o xml.

CopyrightCaption

Este objeto se devuelve de una llamada correcta a copyright.

Name Type Description
copyrightsCaption
  • string

Propiedad Copyrights Caption

formatVersion
  • string

Format Version (propiedad)

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Name Type Description
info
  • object

Información adicional.

type
  • string

Tipo de información adicional.

ErrorDetail

Detalle del error.

Name Type Description
additionalInfo

Información adicional del error.

code
  • string

Código de error.

details

Los detalles del error.

message
  • string

El mensaje de error.

target
  • string

Destino del error.

ErrorResponse

Respuesta de error

Name Type Description
error

Objeto de error.

ResponseFormat

Formato deseado de la respuesta. El valor puede ser json o xml.

Name Type Description
json
  • string

Formato de intercambio de datos de notación de objetos JavaScript

xml
  • string

Lenguaje de marcado extensible