Render - Get Copyright Caption

S’applique à : voir les niveaux tarifaires.

L’API Copyrights est conçue pour fournir des informations sur les droits d’auteur pour le service Render Tile. Outre le droit d’auteur de base pour l’ensemble de la carte, l’API sert des groupes spécifiques de droits d’auteur pour certains pays.

En guise d’alternative aux droits d’auteur pour la demande de carte, il est possible de recevoir des légendes pour afficher les informations du fournisseur de cartes sur la carte.

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

Paramètres URI

Name In Required Type Description
format
path True

Format souhaité de la réponse. La valeur peut être json ou xml.

api-version
query True
  • string

Numéro de version de l’API Azure Maps.

En-tête de la demande

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

Spécifie le compte destiné à être utilisé conjointement avec le modèle de sécurité Azure AD. Il représente un ID unique pour le compte Azure Maps et peut être récupéré à partir de l’API compte de plan de gestion Azure Maps. Pour utiliser la sécurité Azure AD dans Azure Maps consultez les articles suivants pour obtenir des conseils.

Réponses

Name Type Description
200 OK

OK

Other Status Codes

Une erreur inattendue s’est produite.

Sécurité

AADToken

Il s’agit des flux OAuth2 Azure Active Directory . Lorsqu’il est associé au contrôle d’accès en fonction du rôle Azure, il peut être utilisé pour contrôler l’accès à Azure Maps API REST. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs comptes de ressources Azure Maps ou sous-ressources. Tout utilisateur, groupe ou principal de service peut être autorisé à accéder via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour Azure Maps API REST.

Pour implémenter des scénarios, nous vous recommandons d’afficher les concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour la modélisation des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.

Notes

  • Cette définition de sécurité nécessite l’utilisation de l’en-tête x-ms-client-id pour indiquer la ressource Azure Maps à laquelle l’application demande l’accès. Cela peut être acquis à partir de l’API de gestion Maps.

Il Authorization URL est spécifique à l’instance de cloud public Azure. Les clouds souverains ont des URL d’autorisation uniques et des configurations Azure Active Directory. * Le contrôle d’accès en fonction du rôle Azure est configuré à partir du plan de gestion Azure via Portail Azure, PowerShell, CLI, kits SDK Azure ou API REST. * L’utilisation du Kit de développement logiciel (SDK) web Azure Maps permet la configuration basée sur la configuration d’une application pour plusieurs cas d’usage.

  • Actuellement, Azure Active Directory v1.0 ou v2.0 prend en charge les comptes professionnels, scolaires et invités, mais ne prend pas en charge les comptes personnels.

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

Il s’agit d’une clé partagée approvisionnée lorsque vous créez un compte Azure Maps dans le Portail Azure ou à l’aide de PowerShell, CLI, sdk Azure ou API REST.

Avec cette clé, n’importe quelle application peut accéder à toutes les API REST. En d’autres termes, cette clé peut être utilisée comme clé principale dans le compte dans lequel elles sont émises.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’approche des applications clientes confidentielles pour accéder à Azure Maps API REST afin que votre clé puisse être stockée en toute sécurité.

Type: apiKey
In: query

SAS Token

Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération Liste SAS sur la ressource Azure Maps via le plan de gestion Azure via Portail Azure, PowerShell, CLI, kits SDK Azure ou API REST.

Avec ce jeton, toute application est autorisée à accéder avec des contrôles d’accès en fonction du rôle Azure et un contrôle précis à l’expiration, au taux et aux régions d’utilisation pour le jeton particulier. En d’autres termes, le jeton SAP peut être utilisé pour permettre aux applications de contrôler l’accès de manière plus sécurisée que la clé partagée.

Pour les applications exposées publiquement, nous vous recommandons de configurer une liste spécifique d’origines autorisées sur la ressource de compte Map afin de limiter l’abus de rendu et de renouveler régulièrement le jeton SAP.

Type: apiKey
In: header

Exemples

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

Définitions

CopyrightCaption

Cet objet est retourné à partir d’un appel de copyright réussi

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

ResponseFormat

Format souhaité de la réponse. La valeur peut être json ou xml.

CopyrightCaption

Cet objet est retourné à partir d’un appel de copyright réussi

Name Type Description
copyrightsCaption
  • string

Propriété Copyrights Caption

formatVersion
  • string

Format Version, propriété

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Name Type Description
info
  • object

Informations supplémentaires.

type
  • string

Type d’informations supplémentaire.

ErrorDetail

Détail de l’erreur.

Name Type Description
additionalInfo

Informations supplémentaires sur l’erreur.

code
  • string

Code d'erreur.

details

Détails de l’erreur.

message
  • string

Message d’erreur.

target
  • string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Name Type Description
error

Objet d’erreur.

ResponseFormat

Format souhaité de la réponse. La valeur peut être json ou xml.

Name Type Description
json
  • string

Format d’échange de données de notation d’objet JavaScript

xml
  • string

Langage de balisage extensible