Si vous développez un plug-in Google Maps Platform pour des plates-formes comme WordPress, Shopify, Magento et autres, cet article explique comment intégrer rapidement les utilisateurs de ce plug-in dans Google Maps Platform et générer une clé API.
La clé API, que votre plug-in doit envoyer avec chaque requête à Google Maps Platform, est liée au compte Google et aux informations de facturation de l'utilisateur. De plus, elle offre un accès aux fonctionnalités de création de cartes dans votre plug-in.
Pour aider les utilisateurs du plug-in à générer rapidement une clé API, fournissez un lien ou un bouton qui lance le widget de démarrage rapide. Une fenêtre pop-up pratique s'affiche pour guider les utilisateurs via quelques étapes simples. De plus, le widget de démarrage rapide vous permet de garder les utilisateurs du plug-in sur votre plate-forme au lieu de les rediriger vers la console Google Cloud pour effectuer ces tâches dans différentes fenêtres.
Lancer le widget de démarrage rapide
Le widget de démarrage rapide correspond à une simple page Web. Vous pouvez contrôler la taille de la fenêtre avec un appel JavaScript window.open. Exemple :
<script>
function openPopupWindow() {
var winWidth=570;
var winHeight=700;
var left = (screen.width-winWidth)/2;
var top = (screen.height-winHeight)/2;
window.open('https://console.cloud.google.com/google/maps-hosted', 'Quick Start Widget',
'resizable=yes,width='+winWidth+',height='+winHeight+',left='+left+',top='+top);
return false;
}
</script>
<!-- CTA to generate Google Maps API Key -->
<button type="button" onClick="openPopupWindow()" style="color: white; background-color: #1a73e8" href="#">
Get an API Key
</button>
Résultat :
Lorsqu'un utilisateur clique sur le bouton, le widget de démarrage rapide s'ouvre dans une fenêtre pop-up et effectue les opérations suivantes à mesure que l'utilisateur avance dans le widget :
- Il crée un compte Google et un projet si l'utilisateur n'en possède pas déjà.
- Il active les API Google Maps Platform.
- Il génère une clé API que les utilisateurs peuvent copier et coller dans la configuration du plug-in.
Si l'utilisateur du plug-in dispose déjà d'un compte Google et d'un projet, le widget le redirige vers la page "Identifiants" de la console Google Cloud, où il peut obtenir une clé API existante ou en créer une.
Vous pouvez orienter les utilisateurs de votre plug-in vers l'article À propos du widget de démarrage rapide pour plus d'informations.
Questions fréquentes
L'utilisation du widget de démarrage rapide est-elle payante ?
Non. Le widget de démarrage rapide est proposé sans frais pour tous les développeurs afin de simplifier l'intégration dans Google Maps Platform.
Le widget de démarrage rapide peut-il être utilisé uniquement sur WordPress et Shopify ?
Il peut être utilisé sur n'importe quel site Web tiers (pas seulement sur les outils de création de sites Web ni sur les sites e-commerce).
La plate-forme tierce a-t-elle accès aux informations de facturation saisies par l'utilisateur ?
Une fois qu'un utilisateur s'est authentifié auprès de Google, il est le seul à pouvoir accéder à ses données de facturation et autres informations. Les plates-formes tierces et les développeurs de plug-ins n'y ont pas accès.
Puis-je utiliser mon projet et ma clé API existants ?
Si vous disposez déjà d'un compte Google Maps Platform, le widget de démarrage rapide vous redirige vers la console Google Cloud. Vous pouvez alors utiliser une clé API existante ou en générer une.
Comment les utilisateurs du plug-in sécurisent-ils leurs clés API ?
L'article Bonnes pratiques de sécurité pour les API explique comment sécuriser une clé API. Après avoir exécuté le widget de démarrage rapide, les utilisateurs reçoivent également un e-mail contenant des instructions et un lien vers la console Google Cloud pour sécuriser leur clé API.