Cette page explique aux développeurs comment commencer à utiliser les API Google Cloud.
Si vous utilisez les API Google Cloud pour la première fois, vous pouvez suivre les étapes de ce guide pour appeler les API à l'aide des commandes curl
. Vous pouvez utiliser les commandes curl
pour tester une API avant de développer votre application.
Créer un compte Google
Pour utiliser les API Google Cloud dans vos applications, vous devez d'abord disposer d'un compte Google. Vous pouvez ainsi utiliser les produits Google pour les développeurs, y compris Google Cloud Console, gcloud CLI, Cloud Logging et Cloud Monitoring. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $ de crédits gratuits pour exécuter, tester et déployer des charges de travail.
Créer un projet Google
Pour utiliser les API Cloud, vous devez également disposer d'un projet Google. Un projet équivaut à un compte de développeur. Il sert de conteneur pour vos ressources Google Cloud. Il fournit également une limite d'isolation pour votre utilisation des services Google Cloud, vous permettant de gérer les limites de quota et la facturation indépendamment au niveau du projet. La télémétrie et les tableaux de bord concernant l'utilisation sont également regroupés par projet. Si vous n'avez pas encore de projet, vous pouvez en créer un à l'aide de la console Google Cloud.
Un projet peut posséder un large éventail de ressources, y compris des clés API, des clients OAuth, des comptes de service, des VM Compute Engine, des buckets Cloud Storage et des ensembles de données BigQuery. Lorsqu'une application appelle une API Cloud, le projet qui détient les identifiants de l'application est appelé projet client et le projet qui détient la ressource cible est appelé projet de ressource. Une requête API peut toucher plusieurs ressources, ce qui implique plusieurs projets de ressources.
Si vous souhaitez cesser d'utiliser Google Cloud pour une raison quelconque, vous pouvez supprimer votre projet via la console Google Cloud. Votre projet et toutes les ressources qu'il contient seront supprimés après la durée de conservation. Notez que les différents types de données ont des durées de conservation différentes.
Découvrir les API
Avant d'utiliser une APIs Cloud, vous devez utiliser la bibliothèque d'API de la console Google Cloud pour parcourir les APIs Cloud disponibles et découvrir celles qui répondent le mieux aux besoins de votre entreprise. Pour plus d'informations sur une API Cloud spécifique, visitez son site de documentation public, comme l'API Spanner.
Activation des API…
Certaines API Cloud sont activées par défaut. Pour utiliser une API Cloud qui n'est pas activée par défaut, vous devez l'activer pour votre projet. En fonction des services et des projets impliqués dans votre application, y compris le projet client et les projets de ressources, vous devrez peut-être activer une API pour plusieurs projets. Lorsque vous activez une API qui dépend d'autres API, celles-ci sont également activées en même temps.
Pour activer une API, vous devez accepter les conditions d'utilisation et la responsabilité de la facturation de cette API. Vous devez disposer de l'autorisation serviceusage.services.enable
sur le projet pour activer les API. Pour en savoir plus, consultez la section Contrôle des accès de Service Usage.
En outre, le service à activer doit être public, ou le propriétaire du service doit accorder à l'utilisateur l'autorisation servicemanagement.services.bind
sur le service privé. Pour en savoir plus, consultez la page Contrôle des accès à Service Management.
Pour activer une API pour un projet à l'aide de la console, procédez comme suit :
- Accédez à la bibliothèque d'API de la console Google Cloud.
- Dans la liste des projets, sélectionnez celui que vous souhaitez utiliser.
- Dans la bibliothèque d'API, sélectionnez l'API que vous souhaitez activer. Si vous avez besoin d'aide pour trouver l'API, utilisez le champ de recherche et/ou les filtres.
- Sur la page de l'API, cliquez sur ACTIVER.
Sur cette même page, vous pouvez désactiver une API pour votre projet si vous ne l'utilisez plus afin d'éviter une utilisation abusive et des frais de facturation accidentels. Vous pouvez également activer et désactiver les APIs Cloud à l'aide de la CLI gcloud et de l'API Service Usage :
$ gcloud services enable pubsub.googleapis.com
$ gcloud services disable pubsub.googleapis.com
Activation de la facturation en cours
Certaines API Cloud facturent des frais d'utilisation. Vous devez activer la facturation pour votre projet avant de commencer à utiliser ces API dans votre projet. L'utilisation d'une API dans un projet est facturée sur le compte de facturation associé au projet.
Si vous ne possédez pas de compte de facturation, accédez à la page de facturation de la console Google Cloud et suivez les instructions pour en créer un. Ensuite, associez votre compte de facturation à votre projet.
S'authentifier auprès des API
La manière dont vous vous authentifiez auprès d'une API dépend de votre environnement de développement et des méthodes d'authentification compatibles avec l'API.
La configuration des identifiants par défaut de l'application pour une utilisation dans divers environnements est l'approche la plus courante. Elle est recommandée pour la plupart des applications. Si l'API est compatible avec les clés API, il s'agit d'une autre option. Si votre application doit accéder aux ressources Cloud appartenant à vos utilisateurs finaux, vous pouvez créer un ID client OAuth 2.0 et utiliser les bibliothèques d'authentification.
Pour obtenir des informations générales sur l'authentification, consultez la page Authentification sur Google.
Créer des applications
Si vous créez une application à l'aide des API Cloud, nous vous recommandons d'utiliser les bibliothèques clientes Google Cloud, si elles sont disponibles. Les bibliothèques clientes peuvent gérer les fonctionnalités courantes de l'API pour plus de commodité, telles que l'authentification, le traitement des erreurs, les nouvelles tentatives et la validation de la charge utile. Vous devez transmettre les identifiants de votre application aux bibliothèques clientes lors de l'initialisation, afin que ces dernières puissent appeler les API Google Cloud pour le compte de votre application.
Consultez les guides par étapes suivants qui utilisent les bibliothèques clientes pour certaines API populaires:
- API Cloud Billing Budget avec Node.js
- API Cloud Billing Budget avec Python
- Cloud Logging avec Node.js
- Cloud Logging avec Python.
- Cloud Logging avec Go.
- Cloud Logging avec Java
- Speech-to-Text avec Node.js
- Speech-to-Text avec Python
- Speech-to-Text avec Go
- Speech-to-Text avec Java
Pour en savoir plus, consultez la section Présentation des bibliothèques clientes.
Informations complémentaires
Pour en savoir plus sur l'authentification, consultez la page Authentification sur Google.
Pour en savoir plus sur la gestion des erreurs, consultez la page Gérer les erreurs.
Pour plus d'informations sur la facturation, consultez la section Créer, modifier ou fermer votre compte de facturation.
Pour plus d'informations sur l'activation de la facturation pour votre projet, consultez la section Modifier les paramètres de facturation d'un projet.
Pour plus d'informations sur l'activation et la désactivation des API, consultez la section Activer et désactiver des services.