Render - Get Copyright Caption

Reference

Služba:: Maps

Verze rozhraní API:: 2024-04-01

Umožňuje získat informace o autorských právech, které se mají použít při vykreslování dlaždice.

Rozhraní Get Copyright Caption API je požadavek HTTP GET navržený tak, aby poskytoval informace o autorských právech, které se mají používat u dlaždic požadovaných ze služby Render. Kromě základních autorských práv k celé mapě může mapě poskytovat určité skupiny autorských práv pro některé země nebo oblasti.

Jako alternativu k autorským právům k žádosti o mapu může také vrátit titulky pro zobrazení informací o poskytovateli na mapě.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
format	path	True	ResponseFormat	Požadovaný formát odpovědi Hodnota může být json nebo xml.
api-version	query	True	string	Číslo verze rozhraní API služby Azure Maps Aktuální verze je 2024-04-01.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-id		string	Určuje, který účet je určený pro použití ve spojení s modelem zabezpečení Microsoft Entra ID. Představuje jedinečné ID účtu Azure Maps a je možné ho načíst z rozhraní API účtu roviny správy Služby Azure Maps. Informace o použití zabezpečení Microsoft Entra ID v Azure Maps najdete v následujících článcích .

Odpovědi

Name	Typ	Description
200 OK	CopyrightCaption	OK
Other Status Codes	ErrorResponse	Došlo k neočekávané chybě.

Zabezpečení

AADToken

Toto jsou toky Microsoft Entra OAuth 2.0 . Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k rozhraním Azure Maps REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika účtům prostředků nebo dílčím prostředkům Azure Maps. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role složené z jednoho nebo několika oprávnění k rozhraním REST API služby Azure Maps.

Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu pro konkrétní rozhraní API a obory.

Poznámky

Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení prostředku Azure Maps, ke kterému aplikace žádá o přístup. Můžete ho získat z rozhraní MAPS MANAGEMENT API.

Je Authorization URL specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Microsoft Entra ID. * Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API. * Použití sady Azure Maps Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.

Další informace o platformě Microsoft Identity Platform najdete v tématu Přehled platformy Microsoft Identity Platform.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

subscription-key

Jedná se o sdílený klíč, který se zřídí při vytváření prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto klíčem má každá aplikace autorizaci pro přístup ke všem rozhraním REST API. Jinými slovy, ty je v současné době možné považovat za hlavní klíče k účtu, pro který jsou vystavené.

U veřejně vystavených aplikací doporučujeme použít přístup mezi servery k rozhraním REST API služby Azure Maps, kde je možné tento klíč bezpečně uložit.

Typ: apiKey
V: header

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS prostředku Azure Maps prostřednictvím roviny správy Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto tokenem má každá aplikace autorizaci pro přístup pomocí řízení přístupu na základě role v Azure a podrobnou kontrolu vypršení platnosti, četnosti a oblastí použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup zabezpečeným způsobem než sdílený klíč.

U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů v prostředku účtu map , aby se omezilo zneužití vykreslování, a pravidelně obnovovat token SAS.

Typ: apiKey
V: header

Příklady

Successful Copyright Caption Request

Ukázkový požadavek

HTTP

GET https://atlas.microsoft.com/map/copyright/caption/json?api-version=2024-04-01

Ukázková odpověď

Stavový kód:: 200

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

Definice

Name	Description
CopyrightCaption	Tento objekt se vrátí z úspěšného volání autorských práv.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě
ErrorResponse	Chybová odpověď
ResponseFormat	Požadovaný formát odpovědi Hodnota může být json nebo xml.

CopyrightCaption

Tento objekt se vrátí z úspěšného volání autorských práv.

Name	Typ	Description
copyrightsCaption	string	Vlastnost Titulky autorských práv
formatVersion	string	Vlastnost Formát verze

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Typ další informace.

ErrorDetail

Podrobnosti o chybě

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

ResponseFormat

Požadovaný formát odpovědi Hodnota může být json nebo xml.

Name	Typ	Description
json	string	Formát výměny dat zápisu objektů JavaScriptu
xml	string	The Extensible Markup Language

Sdílet prostřednictvím