Integração da prévia particular

Esta é a prévia particular do Universal Ledger. Este guia vai ajudar você a ativar a API e começar a usar seus projetos do Google Cloud .

Solicitação de inclusão na lista de permissões

Como este é um lançamento de prévia privada, você precisa concluir algumas etapas iniciais de integração com seu contato no Google para ter acesso à API. Depois de concluir, você pode ativar a API, atribuir papéis do IAM e começar a enviar solicitações.

  1. Determinar seu ID de cliente ou organização

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

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

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

  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 estão na mesma organização do cliente da etapa 1.

  3. Enviar um e-mail para seu contato do Google

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

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

    Você vai receber uma confirmação quando sua organização e seus projetos forem adicionados à lista de permissões da visualização particular. Depois de concluir essa etapa, você poderá ativar a API.

Ativar a API

Depois que seus projetos forem adicionados à lista de permissões, você poderá ativar a API Universal Ledger usando 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 comando gcloud services enable:

    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 de um projeto, já poderá enviar solicitações para a API.

  2. Configurar 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 aos endpoints e redes disponíveis. Concede a capacidade de visualizar os endpoints e consultar a rede usando um endpoint.
    • roles/universalledger.editor: acesso total aos endpoints e redes disponíveis. Concede acesso para consultar as redes e enviar transações.
    • roles/universalledger.admin: acesso total aos endpoints e redes disponíveis. Concede acesso para consultar as redes e enviar transações. Essa função tem as mesmas permissões que a função de editor do Universal Ledger, mas isso pode mudar no futuro.

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

    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ê já pode começar a usar a API.

Para validar se a configuração anterior está funcionando corretamente, primeiro faça a autenticação usando o comando gcloud auth login:

gcloud auth login

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

curl -H "Authorization: Bearer $(gcloud auth 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 de API, que terão o formato

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

Consulte a referência da API REST ou RPC para mais detalhes sobre os métodos disponíveis.

Redes e regiões disponíveis

Haverá duas redes disponíveis durante a prévia particular:

  • gcul-pilot-testing: recebe atualizações frequentes com recursos experimentais. Use essa rede para iteração rápida e teste de novos tipos de recursos e produtos.
  • gcul-user-testing: a rede atualizada com menos frequência, destinada à integração em fluxos de trabalho de pagamento e liquidação, processando transações de teste e em tempo real.

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