Configurer l'API Enterprise Knowledge Graph

Ce guide décrit toutes les étapes de configuration nécessaires pour commencer à utiliser Enterprise Knowledge Graph.

À propos de la console Google Cloud

Google Cloud console est une interface utilisateur Web permettant de provisionner, configurer, gérer et surveiller les systèmes utilisant des produits Google Cloud . Vous utilisez la console Google Cloud pour configurer et gérer les ressources Enterprise Knowledge Graph.

Créer un projet

Pour utiliser les services fournis par Google Cloud, vous devez créer un projet.

Un projet permet d'organiser toutes vos ressources Google Cloud . Un projet se compose des éléments suivants :

• Un ensemble de collaborateurs
• Des API activées (et autres ressources)
• Outils de surveillance
• Informations bancaires
• L'authentification et le contrôle des accès

Vous pouvez créer un projet ou en créer plusieurs. Vous pouvez utiliser vos projets pour organiser vos ressources Google Cloud dans une hiérarchie des ressources. Pour en savoir plus sur les projets, consultez la documentation de Resource Manager.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Activer l'API

Vous devez activer l'API Enterprise Knowledge Graph pour votre projet. Pour en savoir plus sur l'activation des API, consultez la documentation de Service Usage.

Enable the Enterprise Knowledge Graph API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

Configurer l'authentification

Toute application cliente qui utilise l'API doit être authentifiée et se voir accorder l'accès aux ressources demandées. Cette section décrit des concepts d'authentification importants et vous indique la procédure à suivre pour la configurer. Pour en savoir plus, consultez la Présentation de l'authentification.

À propos des comptes de service

Il existe plusieurs options d'authentification, mais nous vous recommandons d'utiliser les comptes de service pour l'authentification et le contrôle des accès. Un compte de service fournit des identifiants pour les applications, et non pour les utilisateurs finaux. Les comptes de service appartiennent à des projets. Vous pouvez créer plusieurs comptes de service par projet. Pour en savoir plus, consultez la page Comptes de service.

À propos des rôles

Lors de l'appel d'une API, Google Cloud exige que l'identité appelante (toute personne, entité ou processus applicable et ses attributs définis) dispose des autorisations appropriées. Vous pouvez accorder des autorisations en attribuant des rôles à un compte de service. Pour en savoir plus, consultez la documentation sur Identity and Access Management (IAM).

Pour essayer l'API Enterprise Knowledge Graph, vous pouvez utiliser le rôle Projet > Propriétaire dans les étapes suivantes. Le rôle Projet > Propriétaire accorde au compte de service un accès complet aux ressources de votre projet. Si votre compte de service ne nécessite pas d'autorisations complètes, vous pouvez spécifier un rôle plus restrictif à l'aide de la consoleGoogle Cloud . Pour obtenir la liste des autorisations et des rôles pour Enterprise Knowledge Graph, consultez Autorisations Enterprise Knowledge Graph et Rôles Enterprise Knowledge Graph. Pour en savoir plus sur la gestion des autorisations à l'aide des rôles IAM, consultez Attribuer des rôles aux comptes de service.

À propos des clés de compte de service

Les comptes de service sont associés à une ou plusieurs paires de clés publiques ou privées. Lorsque vous créez une paire de clés, vous téléchargez la clé privée. Google Cloud CLI utilise votre clé privée pour générer des identifiants lors de l'appel de l'API.

Remarque : Les clés de compte de service constituent un risque pour la sécurité si elles ne sont pas gérées correctement. Dans la mesure du possible, vous devez choisir une alternative plus sécurisée aux clés de compte de service. Si vous devez vous authentifier avec une clé de compte de service, vous êtes responsable de la sécurité de la clé privée et des autres opérations décrites dans la section Bonnes pratiques pour la gestion des clés de compte de service. Si vous ne parvenez pas à créer une clé de compte de service, il est possible que la création de clé de compte de service soit désactivée pour votre organisation. Pour en savoir plus, consultez la page Gérer les ressources d'organisation sécurisées par défaut.

Si vous avez obtenu la clé de compte de service à partir d'une source externe, vous devez la valider avant de l'utiliser. Pour en savoir plus, consultez Exigences de sécurité pour les identifiants provenant de sources externes.

Créer un compte de service et télécharger le fichier de clé privée

Create a service account:

1. Ensure that you have the Create Service Accounts IAM role (roles/iam.serviceAccountCreator) and the Project IAM Admin role (roles/resourcemanager.projectIamAdmin). Learn how to grant roles.

2. In the Google Cloud console, go to the Create service account page.

   Go to Create service account
3. Select your project.

4. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

   In the Service account description field, enter a description. For example, Service account for quickstart.

5. Click Create and continue.

6. Grant the Project > Owner role to the service account.

   To grant the role, find the Select a role list, then select Project > Owner.

   Note: The Role field affects which resources the service account can access in your project. You can revoke these roles or grant additional roles later. In production environments, do not grant the Owner, Editor, or Viewer roles. Instead, grant a predefined role or custom role that meets your needs.
7. Click Continue.

8. Click Done to finish creating the service account.

   Do not close your browser window. You will use it in the next step.

Create a service account key:

1. In the Google Cloud console, click the email address for the service account that you created.
2. Click Keys.
3. Click Add key, and then click Create new key.
4. Click Create. A JSON key file is downloaded to your computer.
5. Click Close.

Utiliser le fichier de clé de compte de service dans votre environnement

Provide authentication credentials to your application code by setting the environment variable GOOGLE_APPLICATION_CREDENTIALS. This variable applies only to your current shell session. If you want the variable to apply to future shell sessions, set the variable in your shell startup file, for example in the ~/.bashrc or ~/.profile file.

Linux ou macOS

export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

Replace KEY_PATH with the path of the JSON file that contains your credentials.

For example:

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

Windows

For PowerShell:

$env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

Replace KEY_PATH with the path of the JSON file that contains your credentials.

For example:

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

For command prompt:

set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

Replace KEY_PATH with the path of the JSON file that contains your credentials.