Box

El conector de Box te permite conectarte a un backend de Box y usar SQL para recuperar y actualizar los datos de Box.

Versiones compatibles

Este conector es compatible con la versión 2.0 de Box Content API.

Antes de comenzar

Antes de usar el conector de Box, realiza las siguientes tareas:

  • En tu proyecto de Google Cloud, haz lo siguiente:
    • Otorga el rol de IAM roles/connectors.admin al usuario que configura el conector.
    • Otorga los siguientes roles de IAM a la cuenta de servicio que deseas usar para el conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Una cuenta de servicio es un tipo de Cuenta de Google especial que representa a un usuario no humano que debe autenticarse y tener autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crear una. Para obtener más información, consulta Crea una cuenta de servicio.

    • Habilita los siguientes servicios:
      • secretmanager.googleapis.com (API de Secret Manager)
      • connectors.googleapis.com (API de conectores)

      Para comprender cómo habilitar servicios, consulta Habilita servicios.

    Si estos servicios o permisos no se habilitaron antes para tu proyecto, se te solicitará que los habilites cuando configures el conector.

Configura el conector

Para configurar el conector, debes crear una conexión a tu fuente de datos (sistema de backend). Una conexión es específica de una fuente de datos. Significa que, si tienes muchas fuentes de datos, debes crear una conexión independiente para cada fuente. Para crear una conexión, sigue estos pasos:

  1. En la consola de Cloud, ve a la página Conectores de Integration > Conexiones y, luego, selecciona o crea un proyecto de Google Cloud.

    Ir a la página Conexiones

  2. Haz clic en + CREAR NUEVO para abrir la página Crear conexión.
  3. En la sección Ubicación, elige la ubicación para la conexión.
    1. Región: selecciona una ubicación de la lista desplegable.

      Para obtener la lista de todas las regiones compatibles, consulta Ubicaciones.

    2. Haga clic en SIGUIENTE.
  4. En la sección Detalles de la conexión, completa lo siguiente:
    1. Conector: Selecciona Box en la lista desplegable de conectores disponibles.
    2. Versión del conector: selecciona la versión del conector de la lista desplegable de versiones disponibles.
    3. En el campo Nombre de la conexión, ingresa un nombre para la instancia de conexión.

      Los nombres de las conexiones deben cumplir con los siguientes criterios:

      • Los nombres de las conexiones pueden usar letras, números o guiones.
      • Las letras deben estar en minúsculas.
      • Los nombres de las conexiones deben comenzar con una letra y terminar con una letra o un número.
      • Los nombres de las conexiones no pueden superar los 63 caracteres.
    4. De manera opcional, ingresa una Descripción para la instancia de conexión.
    5. Cuenta de servicio: Selecciona una cuenta de servicio que tenga los roles necesarios.
    6. De manera opcional, configura los parámetros de nodo de conexión:

      • Cantidad mínima de nodos: Ingresa la cantidad mínima de nodos de conexión.
      • Cantidad máxima de nodos: Ingresa la cantidad máxima de nodos de conexión.

      Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se requieren más nodos para procesar más transacciones para una conexión y, del mismo modo, se requieren menos para procesar menos transacciones. Para comprender cómo los nodos afectan el precio del conector, consulta Precios de nodos de conexión. Si no ingresas ningún valor, se establecen de forma predeterminada los nodos mínimos en 2 (para una mejor disponibilidad) y los nodos máximos se establecen en 50.

    7. Modo para actuar en nombre del usuario: Especifica el tipo de actuación en nombre del usuario. Debería ser el modo de Usuario o Administrador.
    8. Usar proxy: selecciona esta casilla de verificación a fin de configurar un servidor proxy para la conexión y configurar los siguientes valores:
      • Esquema de autenticación del proxy: Selecciona el tipo de autenticación para autenticar con el servidor proxy. Se admiten los siguientes tipos de autenticación:
        • Básico: Autenticación HTTP básica.
        • Resumen: Autenticación de HTTP de resumen.
      • Usuario de proxy: Un nombre de usuario que se usará para autenticarse con el servidor proxy.
      • Contraseña de proxy: el secreto de Secret Manager de la contraseña del usuario.
      • Tipo de SSL del proxy: el tipo de SSL que se usará para conectarse al servidor del proxy. Se admiten los siguientes tipos de autenticación:
        • Automático: Configuración predeterminada. Si la URL es HTTPS, se usa la opción Túnel. Si la URL es una URL HTTP, se usa la opción NUNCA.
        • Siempre: La conexión siempre está habilitada para SSL.
        • Nunca: La conexión no está habilitada para SSL.
        • Túnel: La conexión se realiza a través de un proxy de túnel. El servidor proxy abre una conexión con el host remoto y el tráfico fluye de un lado a otro a través del proxy.
      • En la sección Proxy Server, ingresa los detalles del servidor proxy.
        1. Haz clic en Agregar destino.
        2. Selecciona un Tipo de destino.
          • Dirección del host: Especifica el nombre de host o la dirección IP del destino.

            Si deseas establecer una conexión privada a tu sistema de backend, haz lo siguiente:

    9. De forma opcional, haz clic en + AGREGAR ETIQUETA para agregar una etiqueta a la conexión en forma de un par clave-valor.
    10. Haga clic en SIGUIENTE.
  5. En la sección Autenticación, ingresa los detalles de autenticación.
    1. Selecciona un Tipo de autenticación y, luego, ingresa los detalles relevantes.

      La conexión de Box admite los siguientes tipos de autenticación:

      • Credenciales de cliente de OAuth 2.0
      • Código de autorización de OAuth 2.0

      2. Para comprender cómo configurar estos tipos de autenticación, consulta Configura la autenticación.

    2. Haga clic en SIGUIENTE.
  6. Revisa: Revisa tus detalles de conexión y autenticación.
  7. Haz clic en Crear.

Configura la autenticación

Ingresa los detalles según la autenticación que desees usar.

  • OAuth 2.0: Credenciales del cliente
    • ID de cliente: el ID de cliente que proporciona el conector para la app que creaste.
    • Secreto de cliente: Secret de Secret Manager que contiene el secreto del cliente para la app conectada que creaste.
    • Clave privada: Secret de Secret Manager que incluye el contenido del archivo de clave privada. La clave privada debe coincidir con la clave o el certificado públicos que se proporcionan al conector.
    • Contraseña de la clave privada: Secret de Secret Manager que contiene la contraseña del archivo de clave privada.
    • Nivel de acceso a la aplicación de Box: nivel de acceso a la aplicación para la aplicación de Box.
    • ID de empresa/ID de usuario: ID de empresa si el nivel de la app es empresarial y el ID del usuario si el nivel de la app es de usuario.
    • ID de clave pública de JWT de OAuth: El ID de la clave pública para JWT.
    • Esquema de autenticación: Esquema de Auth para el conector de Box.
    • Inicia OAuth: Inicia el parámetro de OAuth para el conector de Box.
    • Tipo de certificación de JWT de OAuth: Tipo de certificación de JWT de OAuth para el conector de Box.
  • Código de autorización de OAuth 2.0
    • ID de cliente: Es el ID de cliente que proporciona tu aplicación externa.
    • Permiso: Alcance del permiso. Por ejemplo, root_readonly Para comprender cómo funcionan los permisos y ver todos los permisos disponibles de Box, consulta Permisos.
    • Secreto del cliente: Selecciona el secreto de Secret Manager. Debes crear el secreto de Secret Manager antes de configurar esta autorización.
    • Versión del secreto: La versión del secreto de Secret Manager para el secreto del cliente.

    Para el tipo de autenticación Authorization code, después de crear la conexión, debes realizar algunos pasos adicionales a fin de configurar la autenticación. Para obtener más información, consulta Pasos adicionales después de la creación de la conexión.

Pasos adicionales después de la creación de la conexión

Si seleccionaste OAuth 2.0 - Authorization code para la autenticación, debes seguir estos pasos adicionales después de crear la conexión:

  1. En la página Conexiones, busca la conexión recién creada.

    Ten en cuenta que el Status para el conector nuevo será Authorization required.

  2. Haz clic en Se requiere autorización.

    Se mostrará el panel Editar autorización.

  3. Copia el valor de URI de redireccionamiento a la aplicación externa.
  4. Verifica los detalles de la autorización.
  5. Haz clic en Autorizar.

    Si la autorización se realiza correctamente, el estado de la conexión se establecerá como Activa en la página Conexiones.

Volver a autorizar el código de autorización

Si estás usando el tipo de autenticación Authorization code y realizaste algún cambio en la configuración de tu aplicación de Box, debes volver a autorizar la conexión de Box. Para volver a autorizar una conexión, sigue estos pasos:

  1. Haz clic en la conexión requerida en la página Conexiones.

    Se abrirá la página de detalles de la conexión.

  2. Haz clic en Editar para editar los detalles de la conexión.
  3. Verifica los detalles de OAuth 2.0 - Código de autorización en la sección Autenticación.

    Si es necesario, realiza los cambios necesarios.

  4. Haz clic en Guardar. Esta acción te llevará a la página de detalles de la conexión.
  5. Haz clic en Editar autorización en la sección Autenticación. Esto muestra el panel Autorizar.
  6. Haz clic en Autorizar.

    Si la autorización se realiza correctamente, el estado de la conexión se establecerá como Activa en la página Conexiones.

Entidades, operaciones y acciones

Todos los Integration Connectors proporcionan una capa de abstracción para los objetos de la aplicación conectada. Solo puedes acceder a los objetos de una aplicación a través de esta abstracción. La abstracción se expone como entidades, operaciones y acciones.

  • Entidades: Una entidad puede considerarse como un objeto o una colección de propiedades en la aplicación o servicio conectados. La definición de una entidad difiere de conector a conector. Por ejemplo, en un conector de bases de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; en un conector de sistema de mensajería, las colas son las entidades.

    Sin embargo, es posible que un conector no admita o tenga ninguna entidad, en cuyo caso la lista Entities estará vacía.

  • Operaciones: Una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:

    Cuando se selecciona una entidad de la lista disponible, se genera una lista de operaciones disponibles para esa entidad. Para obtener una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea de conectores. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, tales operaciones no compatibles no aparecerán en la lista Operations.

  • Acción: Una acción es una función de primera clase que está disponible para la integración mediante la interfaz de Conectores. Una acción te permite realizar cambios en una entidad o entidades y variar de un conector a otro. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

Acciones

En esta sección, se enumeran todas las acciones compatibles con la conexión de Box.

Acción DownloadFile

Esta acción te permite descargar un archivo de tu instancia de Box.

Parámetros de entrada de la acción DownloadFile

Nombre del parámetro Tipo de datos Requeridos Descripción
FileID String Sí El ID del archivo que se descargará.
HasBytes Booleano Sí Especifica si se debe descargar el archivo como una cadena o como una cadena codificada en Base64.

Parámetros de resultado de la acción DownloadFile

Esta acción muestra el estado 200 (OK) con un cuerpo de respuesta que indica los resultados.

Nombre del parámetro Tipo de datos Descripción
Se completó correctamente String Especifica si la descarga del archivo se realizó correctamente.
ContentBytes String El contenido del archivo como una string codificada en Base64.

Por ejemplo, para configurar la acción DownloadFile, consulta Ejemplos de acciones.

Acción UploadFile

Esta acción te permite subir un archivo a tu instancia de Box.

Parámetros de entrada de la acción UploadFile

Nombre del parámetro Tipo de datos Requeridos Descripción
ParentID String Sí ID de la carpeta en la que deseas subir el archivo. Si no se especifica este parámetro, el archivo se subirá a la raíz de la cuenta de Box. El valor predeterminado es 0.
Contenido String Sí Es el contenido del archivo que se subirá.

Parámetros de resultado de la acción UploadFile

Esta acción muestra el estado 200 (OK) con un cuerpo de respuesta que indica los resultados.

Nombre del parámetro Tipo de datos Descripción
Se completó correctamente String Especifica si la carga del archivo se realizó correctamente.
ID String ID del archivo creado recientemente.
VersionID String Es el ID de una versión específica del archivo.
Hash String El hash SHA1 del archivo.
ETag String Valor Etag del archivo o la carpeta. El valor predeterminado es 0.

Por ejemplo, para configurar la acción UploadFile, consulta Ejemplos de acciones.

Acción CopyFile

Esta acción te permite copiar un archivo de tu instancia de Box.

Parámetros de entrada de la acción CopyFile

Nombre del parámetro Tipo de datos Requeridos Descripción
FileID String Sí ID del archivo que quieres copiar.
DestinationFolderId String No ID de la carpeta de destino en la que deseas copiar el archivo. Si no especificas ningún valor, se copiará la versión más reciente del archivo.
NewName String Sí Nombre de archivo nuevo para el archivo copiado

Parámetros de resultado de la acción CopyFile

Esta acción muestra el estado 200 (OK) con un cuerpo de respuesta que indica los resultados.

Nombre del parámetro Tipo de datos Descripción
Se completó correctamente String Especifica si la copia del archivo se realizó correctamente.
ID String ID del archivo copiado

Por ejemplo, para configurar la acción CopyFile, consulta Ejemplos de acciones.

Acción CopyFolder

Esta acción te permite copiar una carpeta completa desde tu instancia de Box.

Parámetros de entrada de la acción CopyFolder

Nombre del parámetro Tipo de datos Requeridos Descripción
FolderID String Sí ID de la carpeta que quieres copiar.
DestinationFolderId String Sí ID de la carpeta de destino en la que deseas copiar la carpeta.
NewName String No Nombre de archivo nuevo para la carpeta copiada.

Parámetros de resultado de la acción CopyFolder

Esta acción muestra el estado 200 (OK) con un cuerpo de respuesta que indica los resultados.

Nombre del parámetro Tipo de datos Descripción
Se completó correctamente String Especifica si la copia de la carpeta se realizó correctamente.
ID String ID de la carpeta copiada.

Por ejemplo, para configurar la acción CopyFolder, consulta Ejemplos de acciones.

Ejemplos de acciones

En esta sección, se describe cómo realizar algunas de las acciones en este conector.

Ejemplo: Descarga un archivo

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción DownloadFile y haz clic en Listo.
  3. En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"FileID": "1283194869422", 
"HasBytes": true
}

    4. En este ejemplo, se descarga un archivo como una string codificada en Base64. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    [
{ "Success": "True"},
{"ContentBytes": "JVBERi0xLjQKJcfl9OXwCjIgMCBvYmoKJSBbMjRdIAo8PAovRmlsdGVy"}
]

Ejemplo: Subir un archivo

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción UploadFile y haz clic en Listo.
  3. En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"ParentId": "0",
"Content": "12345"
}

    4. En este ejemplo, se sube contenido de cadenas como un archivo. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    [{
"Success": "true",
"ID": "1283902965389",
"VersionID": "1403546001389",
"Hash": "8cb2237d0679ca88db6464eac60da96345513964",
"Etag": "0"
}]

Ejemplo: copiar un archivo

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción CopyFile y haz clic en Listo.
  3. En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"FileID": "1288751886061",
"DestinationFolderId": "219105724517", 
"NewName": "NewCopiedFile"
}

    4. En este ejemplo, se copia el archivo con el ID 1288751886061 en la carpeta con el ID 219105724517. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    [{
"Success": "true",
"ID": "1308006018536"
}]

Ejemplo: copiar una carpeta

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción CopyFolder y haz clic en Listo.
  3. En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"FolderID": "218475301279",
"DestinationFolderId": "0", 
"NewName": "NewCopiedFolder"
}

    4. En este ejemplo, se copia la carpeta con el ID 218475301279 en la carpeta con el ID 219105724517. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    [{
"Success": "true",
"ID": "226312444517"
}]

Ejemplos de operaciones de entidades

Ejemplo: enumera todos los archivos

En este ejemplo, se enumeran los archivos de la entidad Files.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Files de la lista Entity.
  3. Selecciona la operación LIST y haz clic en Listo.
  4. De manera opcional, puedes ingresar valores en filterClause para filtrar el conjunto de resultados.

Ejemplo: Obtén un boleto

En este ejemplo, se obtiene un ticket específico de la entidad Tickets.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Tickets de la lista Entity.
  3. Selecciona la operación GET y, luego, haz clic en Listo.
  4. En la sección Task Input de la tarea Conectores, haz clic en EntityId y, luego, ingresa 35 en el campo Valor predeterminado.

    Aquí, 35 es el valor de clave primaria de la entidad Tickets.

Ejemplo: Crea un ticket

En este ejemplo, se crea un ticket en la entidad Tickets.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Tickets de la lista Entity.
  3. Selecciona la operación Create y haz clic en Listo.
  4. En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"Subject": "Create_Ticket_01",
"Description": "Test",
"Type": "incident",
"Priority": "urgent",
"Status": "open",
"Recipient": null,
"HasIncidents": false,
"DueAt": null,
"RequesterId": 3.84625885158E11,
"SubmitterId": 3.84625883418E11,
"AssigneeId": 3.84625883418E11,
"OrganizationId": "16665992392721",
"GroupId": 3.60008282358E11,
"TicketFormId": 3.60001719218E11,
"BrandId": 3.60003285058E11
}

    Si la integración se realiza correctamente, el campo connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    {
"Id": 38.0
}

Ejemplo: Actualiza un ticket

En este ejemplo, se actualiza el ticket especificado en la entidad Tickets.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Entradas en la lista Entity.
  3. Selecciona la operación Update y haz clic en Listo.
  4. En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
        "Subject": "Update_Ticket_02",
        "Description": "Updating the ticket",
        "RequesterId": 1.6854335860497E13
      }
  5. Haz clic en entityId y, luego, ingresa 35 en el campo Default Value.

    Como alternativa, en lugar de especificar el entityId, también puedes establecer filterClause en 35.

    Si la integración se realiza correctamente, el campo connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    {
Id": 35.0
}

Ejemplo: Borra un ticket

En este ejemplo, se borra el ticket especificado de la entidad Tickets.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Entradas en la lista Entity.
  3. Selecciona la operación Delete y haz clic en Listo.
  4. En la sección Entrada de tarea de la tarea Conectores, haz clic en entityId y, luego, ingresa 35 en el campo Valor predeterminado.

Usa Terraform para crear conexiones

Puedes usar el recurso de Terraform para crear una conexión nueva.

Si deseas obtener más información para aplicar o quitar una configuración de Terraform, consulta los comandos básicos de Terraform.

Si quieres ver una plantilla de muestra de Terraform para crear conexiones, consulta la plantilla de muestra.

Cuando creas esta conexión en Terraform, debes establecer las siguientes variables en tu archivo de configuración de Terraform:

Nombre del parámetro Tipo de datos Requeridos Descripción
impersonate_user_mode ENUM Verdadero Especifica el tipo de robo de identidad del usuario. Debería ser el modo de Usuario o Administrador. Los valores admitidos son User, Admin.
proxy_enabled BOOLEAN Falso Selecciona esta casilla de verificación para configurar un servidor proxy para la conexión.
proxy_auth_scheme ENUM Falso El tipo de autenticación que se usará para autenticar en el proxy de ProxyServer. Los valores admitidos son BASIC, DIGEST y NONE.
proxy_user STRING Falso Un nombre de usuario que se usará para autenticarse en el proxy de ProxyServer.
proxy_password SECRET Falso Una contraseña que se utilizará para autenticarse en el proxy de ProxyServer.
proxy_ssltype ENUM Falso El tipo de SSL que se usará cuando se establezca la conexión con el proxy de ProxyServer. Los valores admitidos son AUTO, ALWAYS, NEVER, TUNNEL.

Usa la conexión de Box en una integración

Después de crear la conexión, estará disponible en Apigee Integration y en Application Integration. Puedes usar la conexión en una integración mediante la tarea Conectores.

  • Para comprender cómo crear y usar la tarea Conectores en la integración de Apigee, consulta la Tarea Conectores.
  • Para comprender cómo crear y usar la tarea Conectores en Application Integration, consulta la tarea Conectores.

Obtén ayuda de la Comunidad de Google Cloud

Puedes publicar tus preguntas y debatir sobre este conector en la comunidad de Google Cloud en Cloud Forums.

¿Qué sigue?