Render - Get Copyright Caption

Service:

Maps

API-versie:

2024-04-01

Gebruik dit diagram om copyrightinformatie te verkrijgen die moet worden gebruikt bij het weergeven van een tegel.
De Get Copyright Caption-API is een HTTP GET-aanvraag die is ontworpen om copyrightgegevens te verwerken die moeten worden gebruikt met tegels die zijn aangevraagd vanuit de Render-service. Naast een basis copyright voor de hele kaart kan het specifieke groepen copyrights voor sommige landen/regio's bedienen.

Als alternatief voor copyrights voor een kaartaanvraag, kan het ook bijschriften retourneren voor het weergeven van providergegevens op de kaart.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string
format	path	True	ResponseFormat	Gewenste indeling van het antwoord. De waarde kan json- of xml-zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-id		string	Geeft het account aan dat bedoeld is voor gebruik met het Microsoft Entra ID-beveiligingsmodel. Deze unieke ID voor het Azure Maps-account kan worden verkregen via de Azure Maps beheerplane Account API. Voor meer informatie over het gebruik van Microsoft Entra ID beveiliging in Azure Maps, zie Beheer authenticatie in Azure Maps.

Antwoorden

Name	Type	Description
200 OK	CopyrightCaption	De aanvraag is voltooid.
Other Status Codes	ErrorResponse	Een onverwachte foutreactie.

Beveiliging

AadToken

Dit zijn de Microsoft Entra OAuth 2.0 stromen. In combinatie met Azure rolgebaseerde toegang control kan het worden gebruikt om de toegang tot Azure Maps REST-API's te controleren. Azure rolgebaseerde toegangscontroles worden gebruikt om toegang aan een of meer Azure Maps-resourceaccounts of subresources aan te wijzen. Elke gebruiker, groep of servicehoofd kan toegang krijgen via een ingebouwde rol of een aangepaste rol bestaande uit één of meer permissies om REST-API's te Azure Maps.\n\nOm scenario's te implementeren raden we aan om authenticatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van applicatie(s) via objecten die toegang hebben tot specifieke API's en scopes.\n\n#### Notities\n* Deze beveiligingsdefinitie ree het gebruik van de x-ms-client-id header om aan te geven tot welke Azure Maps resource de applicatie toegang vraagt. Dit kan worden verkregen via de Maps management API.\n* \nDe Authorization URL is specifiek voor de Azure publieke cloud-instantie. Sovereign clouds hebben unieke autorisatie-URL's en Microsoft Entra ID-configuraties. \n* \nDe Azure rolgebaseerde toegangscontrole wordt geconfigureerd vanaf het Azure beheerplane via Azure portaal, PowerShell, CLI, Azure-SDK's of REST API's.\n* \nGebruik van de Azure Maps Web SDK maakt configuratie-gebaseerde opstelling van een applicatie voor meerdere gebruikssituaties mogelijk.\n* Voor meer informatie over Microsoft identity platform, zie Microsoft identity platform overzicht.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

subscription-key

Dit is een gedeelde sleutel die wordt ingesteld wanneer je > aanmaakt in het Azure portaal of met PowerShell, CLI, Azure-SDK's of REST API.\n\n Met deze sleutel kan elke applicatie toegang krijgen tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in de rekening waarin ze worden uitgegeven.\n\n Voor publiek blootgestelde applicaties is onze aanbeveling om de confidential client applications benadering te gebruiken om toegang te krijgen tot Azure Maps REST-API's, zodat je sleutel veilig kan worden opgeslagen.

Type: apiKey
In: header

SAS Token

Dit is een shared access signature token dat wordt aangemaakt vanuit de List SAS-operatie op de Azure Maps resource via het Azure beheervlak via Azure portaal, PowerShell, CLI, Azure-SDK's of REST API's.\n\n Met dit token is elke applicatie gemachtigd om toegang te krijgen met Azure rolgebaseerde toegangscontroles en fijnmazige controle over de vervaldatum, snelheid en regio(s) van gebruik voor de betreffende token. Met andere woorden, de SAS Token kan worden gebruikt om applicaties toegang op een veiligere manier te laten beheren dan de gedeelde sleutel.\n\n Voor publiek blootgestelde applicaties is onze aanbeveling om een specifieke lijst van toegestane oorsprongen in de Map-accountresource te configureren om rendermisbruik te beperken en de SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

Successful Copyright Caption Request

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

200

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

Definities

Name	Description
CopyrightCaption	Dit object wordt geretourneerd door een geslaagde copyright-aanroep
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Veelvoorkomende foutrespons voor alle Azure Resource Manager API's om foutdetails terug te geven bij mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)
ResponseFormat	Gewenste indeling van het antwoord. De waarde kan json- of xml-zijn.

CopyrightCaption

Object

Dit object wordt geretourneerd door een geslaagde copyright-aanroep

Name	Type	Description
copyrightsCaption	string	Eigenschap Copyrights Caption
formatVersion	string	Eigenschap Versie opmaken

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info		De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Veelvoorkomende foutrespons voor alle Azure Resource Manager API's om foutdetails terug te geven bij mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

Name	Type	Description
error	ErrorDetail	Het foutobject.

ResponseFormat

Opsomming

Gewenste indeling van het antwoord. De waarde kan json- of xml-zijn.

Waarde	Description
json	De Notatie Data Interchange-indeling voor JavaScript-objecten
xml	De uitbreidbare opmaaktaal