Vista previa de la integración

En esta guía, se explica cómo habilitar la API de Universal Ledger en versión preliminar y cómo comenzar a usarla en tus Google Cloud proyectos.

Solicitud de inclusión en la lista de entidades permitidas

Como el producto está en versión preliminar, se necesitan algunos pasos iniciales de incorporación para obtener acceso a la API. Una vez que se completen, podrás habilitar la API, asignar roles de IAM y comenzar a enviar solicitudes.

  1. Determina el ID de tu cliente o de tu organización

    Antes de la incorporación, tu organización deberá agregarse a una lista de entidades permitidas interna para la API. Deberás proporcionar uno de los siguientes elementos:

    • El ID de cliente de tu organización, que un administrador puede recuperar siguiendo las instrucciones para encontrar tu ID de cliente. Por lo general, este ID comienza con "C" seguido de una serie de caracteres alfanuméricos.

    • El ID de la organización que contiene tus Google Cloud proyectos y recursos. Para obtener orientación, consulta Obtén el ID de tu recurso de organización. Este ID tiene el formato de un número decimal grande.

  2. Selecciona Google Cloud los proyectos

    Identifica o crea los Google Cloud proyectos que deseas usar con la API. Para obtener más información, consulta Crea y administra proyectos. Asegúrate de que estos proyectos existan dentro de la misma organización de clientes del paso (1).

  3. Comunicarse con nosotros

    Envía un correo electrónico a gcul-help@google.com con la siguiente información:

    • Tu ID de cliente o ID de organización del paso (1)
    • La lista de IDs de proyectos del paso (2)

    Recibirás un correo electrónico de confirmación una vez que tu organización y tus proyectos se hayan agregado correctamente a la lista de entidades permitidas de la versión preliminar. Una vez que se complete este paso, podrás habilitar la API.

Habilitar la API

Una vez que se agreguen tus proyectos a la lista de entidades permitidas, podrás habilitar la API de Universal Ledger con gcloud y asignar acceso detallado a los miembros de tu equipo con roles de IAM específicos.

  1. Habilita la API con gcloud

    Para habilitar la API, usa el gcloud services enable comando:

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

    Reemplaza PROJECT_ID por el ID del proyecto en el que deseas habilitar la API.

    Si eres propietario del proyecto, ahora deberías poder enviar solicitudes a la API.

  2. Configura el acceso detallado con roles de IAM

    Para administrar el acceso detallado a la API de Universal Ledger para otros miembros de tu organización, puedes asignarles roles de IAM. La API tiene tres roles de IAM configurados, cada uno de los cuales proporciona diferentes niveles de acceso:

    • roles/universalledger.viewer: Acceso de solo lectura a los extremos y las redes disponibles. Permite visualizar los extremos y consultar la red a través de un extremo.
    • roles/universalledger.editor: Acceso completo a los extremos y las redes disponibles. Otorga acceso para consultar las redes y enviar transacciones.
    • roles/universalledger.admin: Acceso completo a los extremos y las redes disponibles. Otorga acceso para consultar las redes y enviar transacciones. Este rol tiene los mismos permisos que el rol Editor de Universal Ledger, sujeto a cambios en el futuro.

    Para agregar un nuevo rol de IAM a un usuario, usa el gcloud projects add-iam-policy-binding comando:

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

    Reemplaza lo siguiente:

    • PROJECT_ID: el proyecto en el que se agregará la vinculación de política de IAM
    • PRINCIPAL: el principal al que se agrega el rol, por ejemplo, user:test-user@gmail.com o serviceAccount:test123@example.domain.com
    • ROLE: uno de los roles descritos anteriormente para asignar al principal

Envía tu primera solicitud

Ahora puedes comenzar a usar la API.

Para validar que la configuración anterior funcione correctamente, primero autentícate con el gcloud auth application-default login comando:

gcloud auth application-default login

Luego, intenta enviar una endpoints.list solicitud:

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"

Las solicitudes a una red de Universal Ledger determinada se envían mediante extremos de API, que tendrán el formulario

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

Completar estos pasos valida tu acceso a la API de Universal Ledger. Sin embargo, para enviar transacciones a una red, primero deberás crear una cuenta de Universal Ledger. Consulta ¿Qué sigue? para obtener indicaciones sobre los próximos pasos.

Redes y regiones disponibles

Hay dos redes disponibles durante la versión preliminar:

  • gcul-pilot-testing: Recibe actualizaciones frecuentes con funciones experimentales. Esta es la red de uso frecuente para la iteración rápida y para probar nuevos tipos de recursos y productos.
  • gcul-user-testing: La red que se actualiza con menos frecuencia está diseñada para integrarse en flujos de trabajo de pago y liquidación, y para controlar transacciones de prueba y en vivo. Solo está disponible a pedido para casos de uso limitados.

En la siguiente tabla, se resumen las regiones en las que los validadores están disponibles para cada una de estas redes.

Región gcul-pilot-testing gcul-user-testing
us-central1
us-east1
us-east4
us-east5
us-west1
europe-west2
europe-west3

¿Qué sigue?