Intégration à la version Preview privée

Bienvenue dans la version Preview privée d'Universal Ledger ! Ce guide vous aidera à activer l'API et à commencer à l'utiliser dans vos Google Cloud projets.

Demande d'ajout à la liste d'autorisation

Comme il s'agit d'une version Preview privée, vous devrez suivre quelques étapes d'intégration initiales avec votre contact chez Google pour accéder à l'API. Une fois cette opération terminée, vous pourrez activer l'API, attribuer des rôles IAM et commencer à envoyer des requêtes.

  1. Déterminez votre numéro client ou l'ID de votre organisation

    Avant l'intégration, votre organisation devra être ajoutée à une liste d'autorisation interne pour l'API. Vous devrez fournir l'un des éléments suivants :

    • Le numéro client de votre organisation, qu'un administrateur peut récupérer en suivant les instructions de la section Trouver votre numéro client. Cet ID commence généralement par "C", suivi d'une série de caractères alphanumériques.

    • L'ID de l'organisation qui contient vos Google Cloud projets et vos ressources. Pour obtenir des conseils, consultez la section Obtenir l'ID de ressource de votre organisation. Cet ID est au format d'un grand nombre décimal.

  2. Sélectionnez Google Cloud un ou plusieurs projets

    Identifiez ou créez les Google Cloud projets que vous souhaitez utiliser avec l'API. Pour en savoir plus, consultez la section Créer et gérer des projets. Assurez-vous que ces projets existent dans la même organisation cliente que celle de l'étape 1.

  3. Envoyez un e-mail à votre contact Google

    Envoyez un e-mail à gcul-help@google.com contenant les éléments suivants :

    • Votre numéro client ou l'ID de votre organisation de l'étape 1
    • La liste des ID de projet de l'étape 2

    Vous recevrez une réponse de confirmation une fois que votre organisation et vos projets auront été ajoutés à la liste d'autorisation de la version Preview privée. Une fois cette étape terminée, vous pourrez activer l'API.

Activer l'API

Une fois vos projets ajoutés à la liste d'autorisation, vous pouvez activer l'API Universal Ledger à l'aide de gcloud et attribuer un accès précis aux membres de votre équipe à l'aide de rôles IAM spécifiques.

  1. Activer l'API à l'aide de gcloud

    Pour activer l'API, utilisez la gcloud services enable commande :

    gcloud services enable universalledger.googleapis.com \
    --project=PROJECT_ID

    Remplacez PROJECT_ID par l'ID du projet dans lequel vous souhaitez activer l'API.

    Si vous êtes propriétaire du projet, vous devriez maintenant pouvoir envoyer des requêtes à l' API.

  2. Configurer un accès précis à l'aide de rôles IAM

    Pour gérer l'accès précis à l'API Universal Ledger pour les autres membres de votre organisation, vous pouvez leur attribuer des rôles IAM. L'API comporte trois rôles IAM configurés, chacun offrant différents niveaux d'accès :

    • roles/universalledger.viewer: accès en lecture seule aux points de terminaison et aux réseaux disponibles. Permet d'afficher les points de terminaison et d'interroger le réseau à l'aide d'un point de terminaison.
    • roles/universalledger.editor: accès complet aux points de terminaison et aux réseaux disponibles. Permet d'interroger les réseaux et d'envoyer des transactions.
    • roles/universalledger.admin: accès complet aux points de terminaison et aux réseaux disponibles. Permet d'interroger les réseaux et d'envoyer des transactions. Ce rôle dispose des mêmes autorisations que le rôle d'éditeur Universal Ledger, mais cela peut changer à l'avenir.

    Pour ajouter un rôle IAM à un utilisateur, utilisez la commande :gcloud projects add-iam-policy-binding

    gcloud projects add-iam-policy-binding PROJECT_ID \
    --member="PRINCIPAL" \
    --role="ROLE"

    Remplacez les éléments suivants :

    • PROJECT_ID: projet dans lequel ajouter la liaison de stratégie IAM
    • PRINCIPAL: compte principal auquel le rôle est ajouté, par exemple : user:test-user@gmail.com ou serviceAccount:test123@example.domain.com.
    • ROLE: l'un des rôles décrits précédemment à attribuer au compte principal

Envoyer votre première requête

Vous pouvez maintenant commencer à utiliser l'API.

Pour vérifier que la configuration précédente fonctionne correctement, commencez par vous authentifier à l'aide de la gcloud auth login commande :

gcloud auth login

Essayez ensuite d'envoyer une endpoints.list requête :

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -X GET "https://universalledger.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/endpoints"

Les requêtes adressées à un réseau Universal Ledger donné sont envoyées à l'aide de points de terminaison d'API, qui auront la forme

https://universalledger.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/endpoints/NETWORK_NAME

Pour en savoir plus sur les méthodes disponibles, consultez la documentation de référence de l'API REST ou RPC.

Régions et réseaux disponibles

Deux réseaux seront disponibles pendant la version Preview privée :

  • gcul-pilot-testing: reçoit des mises à jour fréquentes avec des fonctionnalités expérimentales. Utilisez ce réseau pour une itération rapide et pour tester de nouveaux types d'actifs et produits.
  • gcul-user-testing: réseau moins fréquemment mis à jour, destiné à l'intégration dans les workflows de paiement et de règlement, et gérant les transactions de test et réelles.

Le tableau suivant récapitule les régions dans lesquelles les validateurs sont disponibles pour chacun de ces réseaux.

Région gcul-pilot-testing gcul-user-testing
us-central1
us-east1
us-east4
us-east5
us-west1
europe-west2
europe-west3

Étape suivante