Box

Il connettore Box ti consente di connetterti a un backend Box e utilizzare SQL per recuperare e aggiornare i dati di Box.

Versioni supportate

Questo connettore supporta l'API Box Content versione 2.0.

Prima di iniziare

Prima di utilizzare il connettore Box, esegui le seguenti attività:

  • Nel tuo progetto Google Cloud:
    • Concedi il ruolo IAM roles/connectors.admin all'utente che configura il connettore.
    • Concedi i seguenti ruoli IAM all'account di servizio che vuoi utilizzare per il connettore:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Un account di servizio è un tipo speciale di Account Google destinato a rappresentare un utente non umano che deve autenticarsi ed essere autorizzato ad accedere ai dati nelle API di Google. Se non hai un account di servizio, devi crearne uno. Per maggiori informazioni, consulta la pagina Creazione di un account di servizio.

    • Abilita i seguenti servizi:
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Per informazioni su come abilitare i servizi, vedi Attivazione dei servizi.

    Se questi servizi o autorizzazioni non sono stati abilitati in precedenza per il tuo progetto, ti viene richiesto di abilitarli durante la configurazione del connettore.

Configura il connettore

Per configurare il connettore è necessario creare una connessione all'origine dati (sistema di backend). Una connessione è specifica per un'origine dati. Se disponi di molte origini dati, devi creare una connessione separata per ciascuna. Per creare una connessione:

  1. Nella console Cloud, vai alla pagina Connettori di integrazione > Connessioni, quindi seleziona o crea un progetto Google Cloud.

    Vai alla pagina Connessioni

  2. Fai clic su + CREA NUOVO per aprire la pagina Crea connessione.
  3. Nella sezione Posizione, scegli la località per la connessione.
    1. Regione: seleziona una località dall'elenco a discesa.

      Per l'elenco di tutte le aree geografiche supportate, consulta la sezione Località.

    2. Fai clic su AVANTI.
  4. Nella sezione Dettagli connessione, completa quanto segue:
    1. Connettore: seleziona Box dall'elenco a discesa dei connettori disponibili.
    2. Versione connettore: seleziona la versione del connettore dall'elenco a discesa delle versioni disponibili.
    3. Nel campo Nome connessione, inserisci un nome per l'istanza di connessione.

      I nomi delle connessioni devono soddisfare i seguenti criteri:

      • I nomi delle connessioni possono contenere lettere, numeri o trattini.
      • Le lettere devono essere minuscole.
      • I nomi delle connessioni devono iniziare con una lettera e terminare con una lettera o un numero.
      • I nomi delle connessioni non possono contenere più di 63 caratteri.
    4. Facoltativamente, inserisci una descrizione per l'istanza di connessione.
    5. Account di servizio: seleziona un account di servizio con i ruoli richiesti.
    6. Facoltativamente, configura le impostazioni del nodo di connessione:

      • Numero minimo di nodi: inserisci il numero minimo di nodi di connessione.
      • Numero massimo di nodi: inserisci il numero massimo di nodi di connessione.

      Un nodo è un'unità (o una replica) di una connessione che elabora le transazioni. Sono necessari più nodi per elaborare più transazioni per una connessione e, al contrario, sono necessari meno nodi per elaborare un numero inferiore di transazioni. Per capire in che modo i nodi influiscono sui prezzi del connettore, consulta Prezzi dei nodi di connessione. Se non inserisci alcun valore, per impostazione predefinita il numero minimo di nodi viene impostato su 2 (per una migliore disponibilità) e il numero massimo di nodi viene impostato su 50.

    7. Impersona modalità utente: specifica il tipo di furto d'identità dell'utente. Deve essere la modalità Utente o la modalità Amministratore.
    8. Utilizza proxy: seleziona questa casella di controllo per configurare un server proxy per la connessione e configurare i seguenti valori:
      • Schema di autenticazione proxy: seleziona il tipo di autenticazione per eseguire l'autenticazione con il server proxy. Sono supportati i seguenti tipi di autenticazione:
        • Di base: autenticazione HTTP di base.
        • Digest: autenticazione HTTP digest.
      • Utente proxy: un nome utente da utilizzare per l'autenticazione con il server proxy.
      • Password proxy: il secret di Secret Manager della password dell'utente.
      • Tipo SSL proxy: il tipo SSL da utilizzare per la connessione al server proxy. Sono supportati i seguenti tipi di autenticazione:
        • Automatica: l'impostazione predefinita. Se l'URL è HTTPS, viene utilizzata l'opzione Tunnel. Se l'URL è HTTP, viene utilizzata l'opzione MAI.
        • Sempre: la connessione è sempre SSL abilitata.
        • Mai: la connessione non è abilitata per SSL.
        • Tunnel: la connessione avviene attraverso un proxy di tunneling. Il server proxy apre una connessione con l'host remoto e il traffico passa attraverso il proxy.
      • Nella sezione Server proxy, inserisci i dettagli del server proxy.
        1. Fai clic su + Aggiungi destinazione.
        2. Seleziona un Tipo di destinazione.
          • Indirizzo host: specifica il nome host o l'indirizzo IP della destinazione.

            Se vuoi stabilire una connessione privata al tuo sistema di backend, segui questi passaggi:

    9. Facoltativamente, fai clic su + AGGIUNGI ETICHETTA per aggiungere un'etichetta alla connessione sotto forma di coppia chiave/valore.
    10. Fai clic su AVANTI.
  5. Nella sezione Autenticazione, inserisci i dettagli di autenticazione.
    1. Seleziona un Tipo di autenticazione e inserisci i dettagli pertinenti.

      La connessione Box supporta i seguenti tipi di autenticazione:

      • OAuth 2.0 - Credenziali client
      • OAuth 2.0 - Codice di autorizzazione
    2. Per informazioni su come configurare questi tipi di autenticazione, consulta l'articolo Configurare l'autenticazione.

    3. Fai clic su AVANTI.
  6. Verifica: controlla i dettagli della connessione e dell'autenticazione.
  7. Fai clic su Crea.

Configura autenticazione

Inserisci i dettagli in base all'autenticazione che vuoi utilizzare.

  • OAuth 2.0 - Credenziali client
    • ID client: l'ID client fornito dal connettore per l'app che hai creato.
    • Client Secret: secret di Secret Manager contenente il client secret per l'app connessa che hai creato.
    • Chiave privata: secret di Secret Manager contenente i contenuti del file della chiave privata. La chiave privata deve corrispondere alla chiave pubblica o al certificato fornito a Connector.
    • Password chiave privata: secret di Secret Manager contenente la password (parafrasi) del file della chiave privata.
    • Box Application Access Level (Livello di accesso all'applicazione Box): livello di accesso all'applicazione per l'app Box
    • ID azienda/ID utente: ID azienda se il livello app è aziendale e ID utente se il livello app è utente
    • ID chiave pubblica JWT OAuth: l'ID della chiave pubblica per JWT.
    • Schema di autenticazione: schema di autenticazione per il connettore di Box
    • Avvia OAuth: consente di avviare il parametro OAuth per Box Connector.
    • Tipo di certificato JWT OAuth: tipo di certificato JWT OAuth per Box Connector
  • OAuth 2.0 - Codice di autorizzazione
    • ID client : l'ID client fornito dall'applicazione esterna.
    • Ambiti: ambiti delle autorizzazioni. Ad esempio, root_readonly. Per comprendere come funzionano gli ambiti e visualizzare tutti gli ambiti disponibili per Box, consulta Ambiti.
    • Client secret: seleziona il secret di Secret Manager. Devi aver creato il secret di Secret Manager prima di configurare questa autorizzazione.
    • Versione secret: versione del secret di Secret Manager per il client secret.

    Per il tipo di autenticazione Authorization code, dopo aver creato la connessione, devi eseguire alcuni passaggi aggiuntivi per configurare l'autenticazione. Per maggiori informazioni, consulta Passaggi aggiuntivi dopo la creazione della connessione.

Ulteriori passaggi dopo la creazione della connessione

Se hai selezionato OAuth 2.0 - Authorization code per l'autenticazione, devi eseguire i seguenti passaggi aggiuntivi dopo aver creato la connessione:

  1. Nella pagina Connessioni, individua la connessione appena creata.

    Tieni presente che lo stato del nuovo connettore sarà Autorizzazione richiesta.

  2. Fai clic su Autorizzazione richiesta.

    Viene visualizzato il riquadro Modifica autorizzazione.

  3. Copia il valore dell'URI di reindirizzamento nell'applicazione esterna.
  4. Verifica i dettagli dell'autorizzazione.
  5. Fai clic su Autorizza.

    Se l'autorizzazione ha esito positivo, lo stato della connessione verrà impostato su Attivo nella pagina Connessioni.

Nuova autorizzazione per il codice di autorizzazione

Se utilizzi il tipo di autenticazione Authorization code e hai apportato modifiche alla configurazione nell'applicazione Box, devi autorizzare di nuovo la connessione Box. Per autorizzare di nuovo una connessione:

  1. Fai clic sulla connessione richiesta nella pagina Connessioni.

    Viene visualizzata la pagina dei dettagli della connessione.

  2. Fai clic su Modifica per modificare i dettagli della connessione.
  3. Verifica i dettagli del codice di autorizzazione OAuth 2.0 nella sezione Autenticazione.

    Se necessario, apporta le modifiche necessarie.

  4. Fai clic su Salva. Verrà visualizzata la pagina dei dettagli della connessione.
  5. Fai clic su Modifica autorizzazione nella sezione Autenticazione. Viene visualizzato il riquadro Autorizza.
  6. Fai clic su Autorizza.

    Se l'autorizzazione ha esito positivo, lo stato della connessione verrà impostato su Attivo nella pagina Connessioni.

Entità, operazioni e azioni

Tutti i connettori di integrazione forniscono un livello di astrazione per gli oggetti dell'applicazione connessa. Puoi accedere agli oggetti di un'applicazione solo tramite questa astrazione. L'astrazione ti viene esposta sotto forma di entità, operazioni e azioni.

  • Entità: un'entità può essere considerata come un oggetto o una raccolta di proprietà nell'applicazione o nel servizio collegato. La definizione di un'entità è diversa da un connettore a un connettore. Ad esempio, in un connettore di database le tabelle sono le entità, in un connettore file server le cartelle sono le entità, mentre in un connettore di sistema di messaggistica le code sono le entità.

    Tuttavia, è possibile che un connettore non supporti o non abbia entità. In questo caso, l'elenco Entities sarà vuoto.

  • Operazione: un'operazione è l'attività che è possibile eseguire su un'entità. Su un'entità puoi eseguire una qualsiasi delle seguenti operazioni:

    Selezionando un'entità dall'elenco disponibile, viene generato un elenco di operazioni disponibili per l'entità. Per una descrizione dettagliata delle operazioni, consulta le operazioni sull'entità dell'attività Connectors. Tuttavia, se un connettore non supporta nessuna delle operazioni relative alle entità, le operazioni non supportate non saranno elencate nell'elenco Operations.

  • Azione: un'azione è una funzione di prima classe resa disponibile per l'integrazione tramite l'interfaccia del connettore. Un'azione consente di apportare modifiche a una o più entità e variare da connettore a connettore. Normalmente, un'azione avrà alcuni parametri di input e un parametro di output. Tuttavia, è possibile che un connettore non supporti alcuna azione, nel qual caso l'elenco Actions sarà vuoto.

Azioni

In questa sezione sono elencate tutte le azioni supportate dalla connessione Box.

Azione DownloadFile

Questa azione ti consente di scaricare un file dalla tua istanza di Box.

Parametri di input dell'azione DownloadFile

Nome parametro Tipo di dati Obbligatorio Descrizione
FileID String L'ID del file da scaricare.
HasBytes Booleano Specifica se scaricare il file come stringa o come stringa codificata Base64.

Parametri di output dell'azione DownloadFile

Questa azione restituisce lo stato 200 (OK) con un corpo della risposta che indica i risultati.

Nome parametro Tipo di dati Descrizione
Riuscito String Specifica se il download del file è riuscito.
ContentBytes String I contenuti del file come stringa codificata Base64.

Ad esempio su come configurare l'azione DownloadFile, consulta Esempi di azioni.

Azione UploadFile

Questa azione ti consente di caricare un file nella tua istanza di Box.

Parametri di input dell'azione UploadFile

Nome parametro Tipo di dati Obbligatorio Descrizione
ParentID String ID della cartella in cui vuoi caricare il file. Se questo parametro non viene specificato, il file verrà caricato nella directory radice dell'account Box. Il valore predefinito è 0.
Contenuti String I contenuti del file da caricare.

Parametri di output dell'azione UploadFile

Questa azione restituisce lo stato 200 (OK) con un corpo della risposta che indica i risultati.

Nome parametro Tipo di dati Descrizione
Riuscito String Specifica se il caricamento del file è riuscito.
ID String ID del file appena creato.
VersionID String ID di una versione specifica del file.
Hash String L'hash SHA1 del file.
ETag String Valore Etag del file o della cartella. Il valore predefinito è 0.

Ad esempio su come configurare l'azione UploadFile, consulta Esempi di azioni.

Azione CopyFile

Questa azione ti consente di copiare un file dalla tua istanza di Box.

Parametri di input dell'azione CopyFile

Nome parametro Tipo di dati Obbligatorio Descrizione
FileID String ID del file che vuoi copiare.
DestinationFolderId String No ID della cartella di destinazione in cui vuoi copiare il file. Se non specifichi alcun valore, viene copiata l'ultima versione del file.
NewName String Nuovo nome per il file copiato.

Parametri di output dell'azione CopyFile

Questa azione restituisce lo stato 200 (OK) con un corpo della risposta che indica i risultati.

Nome parametro Tipo di dati Descrizione
Riuscito String Specifica se la copia del file è riuscita.
ID String ID del file copiato.

Ad esempio su come configurare l'azione CopyFile, consulta Esempi di azioni.

Azione CopiaCartella

Questa azione ti consente di copiare un'intera cartella dalla tua istanza di Box.

Parametri di input dell'azione CopyCartella

Nome parametro Tipo di dati Obbligatorio Descrizione
FolderID String ID della cartella che vuoi copiare.
DestinationFolderId String ID della cartella di destinazione in cui vuoi copiare la cartella.
NewName String No Nuovo nome file per la cartella copiata.

Parametri di output dell'azione CopyCartelle

Questa azione restituisce lo stato 200 (OK) con un corpo della risposta che indica i risultati.

Nome parametro Tipo di dati Descrizione
Riuscito String Specifica se la copia della cartella è riuscita.
ID String ID della cartella copiata.

Ad esempio su come configurare l'azione CopyFolder, consulta Esempi di azioni.

Esempi di azioni

In questa sezione viene descritto come eseguire alcune azioni in questo connettore.

Esempio: download di un file

  1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
  2. Seleziona l'azione DownloadFile e fai clic su Fine.
  3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value:
    {
    "FileID": "1283194869422", 
    "HasBytes": true
    }
  4. Questo esempio scarica un file come stringa codificata Base64. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

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

Esempio - Carica un file

  1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
  2. Seleziona l'azione UploadFile e fai clic su Fine.
  3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value:
    {
    "ParentId": "0",
    "Content": "12345"
    }
  4. In questo esempio i contenuti di stringa vengono caricati sotto forma di file. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

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

Esempio - Copiare un file

  1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
  2. Seleziona l'azione CopyFile e fai clic su Fine.
  3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value:
    {
    "FileID": "1288751886061",
    "DestinationFolderId": "219105724517", 
    "NewName": "NewCopiedFile"
    }
  4. Questo esempio copia il file con ID 1288751886061 nella cartella con ID 219105724517. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

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

Esempio: copia di una cartella

  1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
  2. Seleziona l'azione CopyFolder e fai clic su Fine.
  3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value:
    {
    "FolderID": "218475301279",
    "DestinationFolderId": "0", 
    "NewName": "NewCopiedFolder"
    }
  4. In questo esempio la cartella con ID 218475301279 viene copiata nella cartella con ID 219105724517. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

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

Esempi di operazioni con entità

Esempio: elenca tutti i file

In questo esempio sono elencati i file nell'entità Files.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Files dall'elenco Entity.
  3. Seleziona l'operazione LIST e fai clic su Fine.
  4. Facoltativamente, puoi inserire valori in filterClause per filtrare il set di risultati.

Esempio: Acquisto di un ticket

Questo esempio riceve un ticket specifico dall'entità Tickets.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Tickets dall'elenco Entity.
  3. Seleziona l'operazione GET e fai clic su Fine.
  4. Nella sezione Input attività dell'attività Connettori, fai clic su EntityId (ID entità), quindi inserisci 35 nel campo Valore predefinito.

    In questo caso, 35 è il valore della chiave primaria dell'entità Tickets.

Esempio: creare un ticket

Questo esempio crea un ticket nell'entità Tickets.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Tickets dall'elenco Entity.
  3. Seleziona l'operazione Create e fai clic su Fine.
  4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel 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
    }
        

    Se l'integrazione ha esito positivo, il campo connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

    {
    "Id": 38.0
    } 
        

Esempio: aggiornare un ticket

Questo esempio aggiorna il ticket specificato nell'entità Tickets.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Biglietti dall'elenco Entity.
  3. Seleziona l'operazione Update e fai clic su Fine.
  4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value:
    {
            "Subject": "Update_Ticket_02",
            "Description": "Updating the ticket",
            "RequesterId": 1.6854335860497E13
          }
          
  5. Fai clic su entityId e inserisci 35 nel campo Default Value (Valore predefinito).

    In alternativa, invece di specificare entityId, puoi anche impostare filterClause su 35.

    Se l'integrazione ha esito positivo, il campo connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

    {
    Id": 35.0
    }
          

Esempio: eliminare un ticket

Questo esempio elimina il ticket specificato dall'entità Tickets.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Biglietti dall'elenco Entity.
  3. Seleziona l'operazione Delete e fai clic su Fine.
  4. Nella sezione Input attività dell'attività Connettori, fai clic su entityId, quindi inserisci 35 nel campo Valore predefinito.

Utilizzare Terraform per creare connessioni

Puoi utilizzare la risorsa Terraform per creare una nuova connessione.

Per scoprire come applicare o rimuovere una configurazione Terraform, vedi Comandi Terraform di base.

Per visualizzare un modello Terraform di esempio per la creazione di connessioni, vedi il modello di esempio.

Quando crei questa connessione utilizzando Terraform, devi impostare le seguenti variabili nel file di configurazione di Terraform:

Nome parametro Tipo di dati Obbligatorio Descrizione
impersonate_user_mode ENUM True Specifica il tipo di rappresentazione dell'utente. Deve essere la modalità Utente o la modalità Amministratore. I valori supportati sono: Utente, Amministratore
proxy_enabled BOOLEANO False Seleziona questa casella di controllo per configurare un server proxy per la connessione.
proxy_auth_scheme ENUM False Il tipo di autenticazione da utilizzare per l'autenticazione sul proxy ProxyServer. I valori supportati sono: BASIC, DIGEST, NONE
proxy_user STRING False Un nome utente da utilizzare per l'autenticazione sul proxy ProxyServer.
proxy_password SECRET False Una password da utilizzare per l'autenticazione sul proxy ProxyServer.
proxy_ssltype ENUM False Il tipo SSL da utilizzare per la connessione al proxy ProxyServer. I valori supportati sono: AUTO, ALWAYS, NEVER, TUNNEL

Utilizzare la connessione Box in un'integrazione

Dopo aver creato la connessione, la connessione diventa disponibile sia in Apigee Integration che in Application Integration. Puoi usare la connessione in un'integrazione tramite l'attività Connettori.

  • Per capire come creare e utilizzare l'attività Connectors in Apigee Integration, vedi Attività connettori.
  • Per capire come creare e utilizzare l'attività Connettori in Application Integration, vedi Attività connettori.

Ricevi assistenza dalla community Google Cloud

Puoi pubblicare le tue domande e discutere di questo connettore nella community Google Cloud nei forum di Cloud.

Passaggi successivi