Render - Get Copyright Caption

Область применения: см. ценовые категории.

API авторского права предназначен для предоставления сведений об авторских правах для службы отрисовки плиток. Помимо основных авторских прав на всю карту, API обслуживает определенные группы авторских прав для некоторых стран.

В качестве альтернативы авторским правам для запроса карты можно получить подписи для отображения сведений о поставщике карты на карте.

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

Параметры URI

Name In Required Type Description
format
path True

Требуемый формат ответа. Значением может быть json или xml.

api-version
query True
  • string

Номер версии API Azure Maps

Заголовок запроса

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

Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности Azure AD. Он представляет уникальный идентификатор для учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Инструкции по использованию Azure AD безопасности в Azure Maps см. в следующих статьях.

Ответы

Name Type Description
200 OK

ОК

Other Status Codes

Произошла непредвиденная ошибка.

Безопасность

AADToken

Это потоки OAuth2 Azure Active Directory . При связывании с управлением доступом на основе ролей Azure можно использовать для управления доступом к Azure Maps REST API. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким Azure Maps учетной записи ресурсов или вложенным ресурсам. Доступ к любому пользователю, группе или субъекту-службе можно предоставить через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений для Azure Maps REST API.

Для реализации сценариев рекомендуется просматривать основные понятия проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, способных управлять доступом к определенным API и областям.

Примечания

  • Это определение безопасности требует использования заголовкаx-ms-client-id, чтобы указать, к какой Azure Maps ресурсу приложение запрашивает доступ. Это можно получить из API управления картами.

Это Authorization URL зависит от экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации Azure Active Directory. * Управление доступом на основе ролей Azure настраивается из плоскости управления Azure с помощью Azure-Portal, PowerShell, CLI, пакетов SDK Azure или REST API. * Использование веб-пакета SDK для Azure Maps позволяет настроить приложение на основе конфигурации для нескольких вариантов использования.

  • В настоящее время Azure Active Directory версии 1.0 или версии 2.0 поддерживает рабочие, учебные заведения и гости, но не поддерживает личные учетные записи.

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

Это общий ключ, подготовленный при создании учетной записи Azure Maps в Azure-Portal или с помощью PowerShell, CLI, пакетов SDK Azure или REST API.

С помощью этого ключа любой приложение может получить доступ ко всем REST API. Другими словами, этот ключ можно использовать в качестве главного ключа в учетной записи, в которую они были выданы.

Для общедоступных приложений мы рекомендуем использовать конфиденциальные клиентские приложения для доступа к Azure Maps REST API, чтобы ваш ключ можно было безопасно хранить.

Type: apiKey
In: query

SAS Token

Это маркер подписанного URL-адреса создается из операции "Список SAS" в ресурсе Azure Maps через плоскость управления Azure с помощью Azure-Portal, PowerShell, CLI, пакетов SDK Azure или REST API.

С помощью этого маркера любое приложение имеет право на доступ с помощью управления доступом на основе ролей Azure и точного управления сроком действия, скоростью и регионами, используемыми для конкретного маркера. Иными словами, маркер SAS можно использовать, чтобы приложения могли управлять доступом более безопасным способом, чем общий ключ.

Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи карты , чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.

Type: apiKey
In: header

Примеры

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

Определения

CopyrightCaption

Этот объект возвращается из успешного вызова авторского права

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorDetail

Сведения об ошибке.

ErrorResponse

Сообщение об ошибке

ResponseFormat

Требуемый формат ответа. Значением может быть json или xml.

CopyrightCaption

Этот объект возвращается из успешного вызова авторского права

Name Type Description
copyrightsCaption
  • string

Свойство Caption copyrights

formatVersion
  • string

Свойство Format Version

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Name Type Description
info
  • object

Дополнительные сведения.

type
  • string

Дополнительный тип сведений.

ErrorDetail

Сведения об ошибке.

Name Type Description
additionalInfo

Дополнительные сведения об ошибке.

code
  • string

Код ошибки.

details

Сведения об ошибке.

message
  • string

Сообщение об ошибке.

target
  • string

Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Name Type Description
error

Объект ошибки.

ResponseFormat

Требуемый формат ответа. Значением может быть json или xml.

Name Type Description
json
  • string

Формат обмена данными нотации объектов JavaScript

xml
  • string

Расширяемый язык разметки