Render - Get Copyright Caption

Služba:

Maps

Verze rozhraní API:

2024-04-01

Slouží k získání informací o autorských právech, které můžete použít při vykreslování dlaždice.
Rozhraní API Get Copyright Caption je požadavek HTTP GET určený k poskytování informací o autorských právech, které se mají používat s dlaždicemi požadovanými ze služby Render. Kromě základního autorských práv pro celou mapu může obsluhovat určité skupiny autorských práv pro některé země nebo oblasti.

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

GET {endpoint}/map/copyright/caption/{format}?api-version=2024-04-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string
format	path	True	ResponseFormat	Požadovaný formát odpovědi Hodnota může být json nebo xml.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-id		string	Označuje účet určený pro použití s bezpečnostním modelem Microsoft Entra ID. Toto jedinečné ID pro účet Azure Maps lze získat z API účtu Azure Maps management plane. Pro více informací o používání Microsoft Entra ID bezpečnosti v Azure Maps viz Spravovat autentizaci v Azure Maps.

Odpovědi

Name	Typ	Description
200 OK	CopyrightCaption	Požadavek byl úspěšný.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

AadToken

Jsou to Microsoft Entra OAuth 2.0 Flows. V kombinaci s Azure řízením přístupu založeného na rolích lze použít k řízení přístupu k Azure Maps REST API. Role Azure kontroly přístupu se používají k určení přístupu k jednomu nebo více účtům nebo podzdrojům Azure Maps. Každému uživateli, skupině nebo principálu služby může být udělen přístup prostřednictvím vestavěné role nebo vlastní role složené z jednoho či více oprávnění k Azure Maps REST API.\n\nPro implementaci scénářů doporučujeme zobrazit koncepty autentizace. Shrnuto, tato definice bezpečnosti poskytuje řešení pro modelování aplikací pomocí objektů schopných kontroly přístupu ke specifickým API a rozsahům.\n\n#### Poznámky\n* Tato bezpečnostní definice vyžaduje použití hlavičky x-ms-client-id k označení, ke kterému Azure Maps zdroji aplikace žádá přístup. Tuto možnost lze získat z API pro správu Maps.\n* \nAuthorization URL je specifický pro instanci Azure veřejného cloudu. Suverénní cloudy mají unikátní autorizační URL a konfigurace Microsoft Entra ID. \n* \nŘízení přístupu založené na rolích Azure je konfigurováno z Azure management plane prostřednictvím Azure portálu, PowerShellu, CLI, Sady Azure SDK nebo REST API.\n* \nVyužití Azure Maps Web SDK umožňuje konfigurační nastavení aplikace pro více případů použití.\n* Pro více informací o Microsoft identity platform viz přehled Microsoft identity platform přehled.

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

Rozsahy

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

subscription-key

Jedná se o sdílený klíč, který se zpřístupní, když Vytvoříte Azure Maps účet v Azure portálu nebo pomocí PowerShell, CLI, Sady Azure SDK či REST API.\n\n S tímto klíčem může jakákoli aplikace přistupovat ke všem REST API. Jinými slovy, tento klíč lze použít jako hlavní klíč v účtu, na který jsou vydávány.\n\n Pro veřejně přístupné aplikace doporučujeme použít přístup confidential client applications k přístupu Azure Maps REST API, aby mohl být klíč bezpečně uložen.

Typ: apiKey
V: header

SAS Token

Tento token sdíleného přístupového podpisu je vytvořen operací List SAS na Azure Maps resource přes Azure management plane přes Azure portál, PowerShell, CLI, Sady Azure SDK nebo REST API.\n\n S tímto tokenem je jakákoli aplikace oprávněna přistupovat pomocí Azure Kontroly přístupu založené na rolích a jemná opatření k expiraci, rychlosti a regionům využití konkrétního tokenu. Jinými slovy, SAS Token lze použít k tomu, aby aplikace mohly bezpečněji kontrolovat přístup než sdílený klíč.\n\n Pro veřejně vystavené aplikace doporučujeme nastavit konkrétní seznam povolených původů na zdroji účtu Map, aby se omezilo zneužívání vykreslování a pravidelně obnovovat SAS Token.

Typ: apiKey
V: header

Příklady

Successful Copyright Caption Request

Ukázkový požadavek

HTTP

GET {endpoint}/map/copyright/caption/json?api-version=2024-04-01

Ukázková odpověď

Stavový kód:

200

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

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	Běžná chybová odpověď pro všechna API Azure Resource Manager pro vrácení chybových údajů o neúspěšných operacích. (To se také řídí formátem odpovědi na chybu OData.)
ResponseFormat	Požadovaný formát odpovědi Hodnota může být json nebo xml.

CopyrightCaption

Objekt

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 Format Version

ErrorAdditionalInfo

Objekt

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

Name	Typ	Description
info		Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

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

Objekt

Běžná chybová odpověď pro všechna API Azure Resource Manager pro vrácení chybových údajů o neúspěšných operacích. (To se také řídí formátem odpovědi na chybu OData.)

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

ResponseFormat

Výčet

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

Hodnota	Description
json	formát výměny dat javascriptového objektu
xml	rozšiřitelného jazyka značek