Render - Get Copyright From Bounding Box

Ссылка

Служба:: Maps

Версия API:: 1.0

Возвращает сведения об авторских правах для указанного ограничивающего прямоугольника.

Примечание

Azure Maps отрисовка службы версии 1

Служба Azure Maps Render версии 1 устарела и будет прекращена 17.09.26. Чтобы избежать перебоев в работе служб, все вызовы API render версии 1 должны быть обновлены для использования API render версии 2 до 17.09.26.

Запросы ограничивающего прямоугольника должны указывать координаты минимальной и максимальной долготы и широты (EPSG-3857)

GET https://atlas.microsoft.com/map/copyright/bounding/{format}?api-version=1.0&mincoordinates={mincoordinates}&maxcoordinates={maxcoordinates}

С использованием необязательных параметров:

GET https://atlas.microsoft.com/map/copyright/bounding/{format}?api-version=1.0&mincoordinates={mincoordinates}&maxcoordinates={maxcoordinates}&text={text}

Параметры URI

Имя	В	Обязательно	Тип	Описание
format	path	True	ResponseFormat	Требуемый формат ответа. Значение может быть либо json , либо xml.
api-version	query	True	string	Номер версии API Azure Maps
maxcoordinates	query	True	number[]	Максимальные координаты (северо-восточная точка) ограничивающего прямоугольника в системе координат широты долготы. Например, 52,41064,4,84228
mincoordinates	query	True	number[]	Минимальные координаты (юго-западная точка) ограничивающего прямоугольника в системе координат широты долготы. Например, 52,41064,4,84228
text	query		IncludeText	Значение "Да/нет", чтобы исключить текстовые данные из ответа. В ответе будут только изображения и названия стран или регионов.

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

Имя	Обязательно	Тип	Описание
x-ms-client-id		string	Указывает учетную запись, предназначенную для использования в сочетании с моделью безопасности Microsoft Entra ID. Он представляет уникальный идентификатор для учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Инструкции по использованию Microsoft Entra ID безопасности в Azure Maps см. в следующих статьях.

Ответы

Имя	Тип	Описание
200 OK	Copyright	ОК
Other Status Codes	ErrorResponse	Произошла непредвиденная ошибка.

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

AADToken

Это Microsoft Entra потоков OAuth 2.0. В сочетании с управлением доступом на основе ролей Azure его можно использовать для управления доступом к Azure Maps REST API. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким учетным записям Azure Maps ресурсов или вложенным ресурсам. Любому пользователю, группе или субъекту-службе может быть предоставлен доступ через встроенную или пользовательскую роль, состоящую из одного или нескольких разрешений для Azure Maps REST API.

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

Примечания

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

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

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

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

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

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

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

Тип: apiKey
В: query

SAS Token

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

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

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

Тип: apiKey
В: header

Примеры

Successful Bounding Box Copyright Request

Образец запроса

HTTP

GET https://atlas.microsoft.com/map/copyright/bounding/json?api-version=1.0&mincoordinates=52.41064,4.84228&maxcoordinates=52.41072,4.84239&text=yes

Пример ответа

Код состояния:: 200

{
  "formatVersion": "0.0.1",
  "generalCopyrights": [
    "© 1992 – 2016 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection, database right protection and other intellectual property rights owned by TomTom or its suppliers. The use of this material is subject to the terms of a license agreement. Any unauthorized copying or disclosure of this material will lead to criminal and civil liabilities.",
    "Data Source © 2016 TomTom",
    "based on"
  ],
  "regions": [
    {
      "copyrights": [
        "Topografische onderground Copyright © dienst voor het kadaster en de openbare registers, Apeldoorn 2016."
      ],
      "country": {
        "ISO3": "NLD",
        "label": "Netherlands"
      }
    }
  ]
}

Определения

Имя	Описание
Copyright	Этот объект возвращается из успешного запроса авторских прав
Country	Свойство Country
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
IncludeText	Значение "Да/нет", чтобы исключить текстовые данные из ответа. В ответе будут только изображения и названия стран или регионов.
RegionCopyrights
ResponseFormat	Требуемый формат ответа. Значение может быть либо json , либо xml.

Copyright

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

Имя	Тип	Описание
formatVersion	string	Свойство Format Version
generalCopyrights	string[]	Общий массив авторских прав
regions	RegionCopyrights[]	Массив Regions

Country

Свойство Country

Имя	Тип	Описание
ISO3	string	Свойство ISO3
label	string	Свойство Label

ErrorAdditionalInfo

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

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorDetail

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

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

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

Имя	Тип	Описание
error	ErrorDetail	Объект error.

IncludeText

Значение "Да/нет", чтобы исключить текстовые данные из ответа. В ответе будут только изображения и названия стран или регионов.

Имя	Тип	Описание
no	string	Исключите текстовые данные из ответа. В ответе будут только изображения и названия стран или регионов.
yes	string	Включите в ответ все текстовые данные.

RegionCopyrights

Имя	Тип	Описание
copyrights	string[]	Массив "Авторские права"
country	Country	Свойство Country

ResponseFormat

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

Имя	Тип	Описание
json	string	Формат обмена данными нотации объектов JavaScript
xml	string	Язык расширяемой разметки

Поделиться через