Render - Get Copyright Caption

Gäller för: se prisnivåer.

API:et copyright är utformat för att tillhandahålla upphovsrättsinformation för rendera paneltjänsten. Förutom grundläggande upphovsrätt för hela kartan betjänar API specifika grupper av upphovsrätter för vissa länder.

Som ett alternativ till upphovsrätt för kartbegäran kan man ta emot undertexter för att visa kartproviderns information på kartan.

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

URI-parametrar

Name In Required Type Description
format
path True

Önskat format för svaret. Värdet kan vara antingen json eller xml.

api-version
query True
  • string

Versionsnummer för Azure Maps API.

Begärandehuvud

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

Anger vilket konto som är avsett för användning tillsammans med Azure AD säkerhetsmodell. Det representerar ett unikt ID för Azure Maps-kontot och kan hämtas från konto-API:et för Azure Maps hanteringsplan. Information om hur du använder Azure AD säkerhet i Azure Maps finns i följande artiklar.

Svar

Name Type Description
200 OK

OK

Other Status Codes

Det uppstod ett oväntat fel.

Säkerhet

AADToken

Det här är Azure Active Directory OAuth2-flöden . När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps resurskonto eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter för att Azure Maps REST-API:er.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan ha åtkomstkontroll för specifika API:er och omfång.

Kommentarer

  • Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från MAPS-hanterings-API:et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Azure Active Directory-konfigurationer. * Rollbaserad åtkomstkontroll i Azure konfigureras från Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er. * Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.

  • För närvarande har Azure Active Directory v1.0 eller v2.0 stöd för arbete, skola och gäster, men har inte stöd för personliga konton.

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

Det här är en delad nyckel som etableras när du skapar ett Azure Maps-konto i Azure Portal eller använder PowerShell, CLI, Azure SDK:er eller REST API.

Med den här nyckeln kan alla program komma åt alla REST-API:et. Med andra ord kan den här nyckeln användas som huvudnyckel i det konto som de har utfärdats i.

För offentligt exponerade program rekommenderar vi att du använder metoden för konfidentiella klientprogram för att komma åt Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.

Type: apiKey
In: query

SAS Token

Det här är en signaturtoken för delad åtkomst som skapas från åtgärden Lista SAS på den Azure Maps resursen via Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er.

Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll av förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett säkrare sätt än den delade nyckeln.

För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på map-kontoresursen för att begränsa återgivningsmissbruket och regelbundet förnya SAS-token.

Type: apiKey
In: header

Exempel

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

Definitioner

CopyrightCaption

Det här objektet returneras från ett lyckat upphovsrättsanrop

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

ResponseFormat

Önskat format för svaret. Värdet kan vara antingen json eller xml.

CopyrightCaption

Det här objektet returneras från ett lyckat upphovsrättsanrop

Name Type Description
copyrightsCaption
  • string

Copyrights Caption-egenskap

formatVersion
  • string

Formatversionsegenskap

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Type Description
info
  • object

Ytterligare information.

type
  • string

Den ytterligare informationstypen.

ErrorDetail

Felinformationen.

Name Type Description
additionalInfo

Ytterligare information om felet.

code
  • string

Felkoden.

details

Felinformationen.

message
  • string

Felmeddelandet.

target
  • string

Felmålet.

ErrorResponse

Felsvar

Name Type Description
error

Felobjektet.

ResponseFormat

Önskat format för svaret. Värdet kan vara antingen json eller xml.

Name Type Description
json
  • string

Datautbytesformat för JavaScript-objektnotation

xml
  • string

Utökningsbart markeringsspråk