Prévia da integração

Este guia ajuda você a ativar a API Universal Ledger Preview e começar a usar em seus Google Cloud projetos.

Solicitação da lista de permissões

Como o produto está na versão de visualização, algumas etapas iniciais de integração são necessárias para acessar a API. Depois de concluir, você pode ativar a API, atribuir papéis do IAM e começar a enviar solicitações.

  1. Determinar o ID do cliente ou da organização

    Antes da integração, sua organização precisa ser adicionada a uma lista de permissões interna da API. Você precisa fornecer um destes:

    • O ID do cliente da sua organização, que pode ser recuperado por um administrador seguindo as instruções em Encontrar seu ID de cliente. Esse ID geralmente começa com "C" seguido por uma série de caracteres alfanuméricos.

    • O ID da organização que contém seus Google Cloud projetos e recursos. Para orientações, consulte Como ter acesso ao ID do recurso da organização. Esse ID é formatado como um número decimal grande.

  2. Selecionar Google Cloud projetos

    Identifique ou crie os Google Cloud projetos que você quer usar com a API. Para saber mais, consulte Como criar e gerenciar projetos. Verifique se esses projetos existem na mesma organização do cliente da etapa 1.

  3. Entre em contato

    Envie um e-mail para gcul-help@google.com contendo:

    • Seu ID de cliente ou ID da organização da etapa 1
    • A lista de IDs de projetos da etapa 2

    Você vai receber um e-mail de confirmação quando sua organização e seus projetos forem adicionados à lista de permissões de visualização. Depois de concluir essa etapa, você pode ativar a API.

Ative a API

Depois que seus projetos forem adicionados à lista de permissões, você poderá ativar a API Universal Ledger usando a gcloud e atribuir acesso granular aos membros da equipe usando papéis específicos do IAM.

  1. Ativar a API usando a gcloud

    Para ativar a API, use o gcloud services enable comando:

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

    Substitua PROJECT_ID pelo ID do projeto em que você quer ativar a API.

    Se você for proprietário do projeto, poderá enviar solicitações à API.

  2. Configurar o acesso granular usando papéis do IAM

    Para gerenciar o acesso granular à API Universal Ledger para outros membros da sua organização, atribua papéis do IAM a eles. A API tem três papéis do IAM configurados, cada um fornecendo diferentes camadas de acesso:

    • roles/universalledger.viewer: acesso somente leitura a endpoints e redes disponíveis. Concede a capacidade de visualizar os endpoints e consultar a rede usando um endpoint.
    • roles/universalledger.editor: acesso total a endpoints e redes disponíveis. Concede acesso para consultar as redes e enviar transações.
    • roles/universalledger.admin: acesso total a endpoints e redes disponíveis. Concede acesso para consultar as redes e enviar transações. Esse papel tem as mesmas permissões que o papel de Editor do Universal Ledger, sujeito a mudanças no futuro.

    Para adicionar um novo papel do IAM a um usuário, use o gcloud projects add-iam-policy-binding comando:

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

    Substitua:

    • PROJECT_ID: o projeto em que a vinculação de política do IAM será adicionada
    • PRINCIPAL: o principal a quem o papel é adicionado, por exemplo: user:test-user@gmail.com ou serviceAccount:test123@example.domain.com.
    • ROLE: um dos papéis descritos anteriormente para atribuir ao principal

Enviar sua primeira solicitação

Agora você pode começar a usar a API.

Para validar se a configuração anterior está funcionando corretamente, primeiro autentique usando o gcloud auth application-default login comando:

gcloud auth application-default login

Em seguida, tente enviar uma endpoints.list solicitação:

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

As solicitações para uma determinada rede do Universal Ledger são enviadas usando endpoints da API, que terão o formulário

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

Concluir essas etapas valida seu acesso à API Universal Ledger. No entanto, para enviar transações a uma rede, primeiro você precisa criar uma conta do Universal Ledger. Consulte a seção A seguir para ver dicas sobre as próximas etapas.

Redes e regiões disponíveis

Há duas redes disponíveis durante a visualização:

  • gcul-pilot-testing: recebe atualizações frequentes com recursos experimentais. Essa é a rede mais usada com frequência para iteração rápida e teste de novos tipos de recursos e produtos.
  • gcul-user-testing: a rede menos atualizada, destinada à integração em fluxos de trabalho de pagamento e liquidação, processando transações de teste e reais. Disponível apenas mediante solicitação para casos de uso limitados.

A tabela a seguir resume as regiões em que os validadores estão disponíveis para cada uma dessas redes.

Região gcul-pilot-testing gcul-user-testing
us-central1
us-east1
us-east4
us-east5
us-west1
europe-west2
europe-west3

A seguir