Questa pagina è stata tradotta dall'API Cloud Translation.

Box

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

Versioni supportate

Questo connettore supporta la versione 2.0 dell'API Box Content.

Prima di iniziare

Prima di utilizzare il connettore Box, svolgi i seguenti passaggi:

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 saperne di più, consulta la pagina sulla 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 Abilitazione dei servizi.
Se questi servizi o queste autorizzazioni non sono stati abilitati per il tuo progetto in precedenza, ti verrà chiesto 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. Ciò significa che se disponi di molte origini dati, devi creare una connessione separata per ciascuna. Per creare una connessione, segui questi passaggi:

Nella console Cloud, vai alla pagina Connettori di integrazione > Connessioni, quindi seleziona o crea un progetto Google Cloud.
Vai alla pagina Connessioni
Fai clic su + CREA NUOVO per aprire la pagina Crea connessione.
Nella sezione Posizione, scegli la località per la connessione.
1. Regione: seleziona una località dall'elenco a discesa.
  Per l'elenco di tutte le regioni supportate, vedi Località.
2. Fai clic su AVANTI.
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 superare i 63 caratteri.
4. (Facoltativo) 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 minore 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 è impostato su 2 (per una migliore disponibilità) e il numero massimo di nodi è impostato su 50.
7. Impersona modalità utente: specifica il tipo di furto d'identità dell'utente. in modalità Utente o Amministratore.
8. Utilizza proxy: seleziona questa casella di controllo per configurare un server proxy per la connessione e configurare i seguenti valori:
9. Facoltativamente, fai clic su + AGGIUNGI ETICHETTA per aggiungere un'etichetta alla connessione sotto forma di coppia chiave-valore.
10. Fai clic su AVANTI.
Nella sezione Autenticazione, inserisci i dettagli di autenticazione.
1. Seleziona un Tipo di autenticazione e inserisci i dettagli pertinenti.
  La connessione a Box supporta i seguenti tipi di autenticazione:
  - OAuth 2.0 - Credenziali client
  - OAuth 2.0 - Codice di autorizzazione
2. Fai clic su AVANTI.
Verifica: controlla i dettagli di connessione e autenticazione.
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 creata.
- Client secret: il secret di Secret Manager contenente il client secret per l'app connessa che hai creato.
- Chiave privata: il secret di Secret Manager che contiene i contenuti del file della chiave privata. La chiave privata deve corrispondere alla chiave pubblica o al certificato fornito al connettore.
- Password della chiave privata: il secret di Secret Manager contenente la password (parafrasi) del file della chiave privata.
- Livello di accesso applicazione Box: livello di accesso all'applicazione per l'app Box
- ID azienda/ID utente: ID azienda se il livello dell'app è a livello aziendale e ID utente se a livello di app è un utente.
- ID chiave pubblica JWT OAuth: l'ID della chiave pubblica per JWT.
- Schema di autenticazione: schema di autenticazione per il connettore Box
- Iniziativa OAuth: avvia il parametro OAuth per il connettore di Box
- OAuth JWT Cert Type (Tipo di certificazione 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 : gli ambiti delle autorizzazioni. Ad esempio, root_readonly. Per comprendere come funzionano gli ambiti e visualizzare tutti quelli disponibili per Box, consulta la pagina Ambiti.
Client secret: seleziona il secret di Secret Manager. Devi aver creato il secret di Secret Manager prima di configurare questa autorizzazione.
Versione del secret : la 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.

Nota: se utilizzi il tipo di autenticazione Authorization code e hai apportato modifiche alla configurazione nell'applicazione Box, devi autorizzare di nuovo la connessione a Box. Per informazioni su come riautorizzare, consulta Nuova autorizzazione per il codice di autorizzazione.

Passaggi aggiuntivi dopo la creazione della connessione

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

Nella pagina Connessioni, individua la connessione appena creata.
Tieni presente che lo Stato del nuovo connettore sarà Autorizzazione richiesta.
Fai clic su Autorizzazione richiesta.
Viene visualizzato il riquadro Modifica autorizzazione.
Copia il valore URL di reindirizzamento nella tua applicazione esterna.
Verifica i dettagli dell'autorizzazione.
Fai clic su Autorizza.
Se l'autorizzazione ha esito positivo, lo stato della connessione verrà impostato su Attivo nella pagina Connessioni.

Nuova autorizzazione del 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 a Box. Per autorizzare di nuovo una connessione, segui questi passaggi:

Fai clic sulla connessione richiesta nella pagina Connessioni.
Viene visualizzata la pagina dei dettagli della connessione.
Fai clic su Modifica per modificare i dettagli della connessione.
Verifica i dettagli di OAuth 2.0 - Codice di autorizzazione nella sezione Autenticazione.
Se necessario, apporta le modifiche necessarie.
Fai clic su Salva. Viene visualizzata la pagina dei dettagli della connessione.
Fai clic su Modifica autorizzazione nella sezione Autenticazione. Viene visualizzato il riquadro Autorizza.
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 è esposta come 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 di file server, le cartelle sono le entità e in un connettore di sistema di messaggistica le code sono le entità.
Tuttavia, è possibile che un connettore non supporti o non abbia entità, nel qual caso l'elenco Entities sarà vuoto.
Operazione : un'operazione è l'attività che puoi eseguire su un'entità. Su un'entità puoi eseguire una qualsiasi delle seguenti operazioni:
- Elenca
- Scarica
- Crea
- Aggiorna
- Elimina
Se selezioni un'entità dall'elenco disponibile, viene generato un elenco di operazioni disponibili per l'entità. Per una descrizione dettagliata delle operazioni, consulta le operazioni delle entità dell'attività Connettori. Tuttavia, se un connettore non supporta nessuna delle operazioni delle entità, queste operazioni non supportate non sono elencate nell'elenco Operations.
Azione: un'azione è una funzione di prima classe resa disponibile per l'integrazione attraverso l'interfaccia del connettore. Un'azione consente di apportare modifiche a una o più entità e di variare da connettore a connettore. 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 a Box.

Azione DownloadFile

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

Parametri di input dell'azione DownloadFile

Nome parametro	Tipo di dati	Obbligatorio	Descrizione
FileID	Stringa	Sì	L'ID del file da scaricare.
HasBytes	Booleano	Sì	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
Operazione riuscita	Stringa	Specifica se il download del file è riuscito.
ContentBytes	Stringa	Il contenuto del file come stringa codificata Base64.

Ad esempio, consulta la sezione Esempi di azioni per configurare l'azione DownloadFile.

Azione Carica file

Questa azione consente di caricare un file sulla tua istanza di Box.

Parametri di input dell'azione UploadFile

Nome parametro	Tipo di dati	Obbligatorio	Descrizione
ParentID	Stringa	Sì	ID della cartella in cui vuoi caricare il file. Se questo parametro non viene specificato, il file verrà caricato nella directory principale dell'account Box. Il valore predefinito è 0.
Contenuti	Stringa	Sì	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
Operazione riuscita	Stringa	Specifica se il caricamento del file è riuscito.
ID	Stringa	ID del file appena creato.
VersionID	Stringa	ID di una versione specifica del file.
Hash	Stringa	L'hash `SHA1` del file.
ETag	Stringa	Valore Etag del file o della cartella. Il valore predefinito è 0.

Ad esempio, consulta la sezione Esempi di azioni per configurare l'azione UploadFile.

Azione Copia file

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

Parametri di input dell'azione CopyFile

Nome parametro	Tipo di dati	Obbligatorio	Descrizione
FileID	Stringa	Sì	ID del file da copiare.
DestinationFolderId	Stringa	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	Stringa	Sì	Nuovo nome del 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
Operazione riuscita	Stringa	Specifica se la copia del file è riuscita.
ID	Stringa	ID del file copiato.

Ad esempio, consulta la sezione Esempi di azioni per configurare l'azione CopyFile.

Azione CopiaCartella

Questa azione 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	Stringa	Sì	ID della cartella da copiare.
DestinationFolderId	Stringa	Sì	ID della cartella di destinazione in cui vuoi copiare la cartella.
NewName	Stringa	No	Nuovo nome file per la cartella copiata.

Parametri di output dell'azione CopyCartella

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

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

Ad esempio, consulta la sezione Esempi di azioni per configurare l'azione CopyFolder.

Esempi di azioni

Questa sezione descrive come eseguire alcune delle azioni in questo connettore.

Esempio: scaricare un file

Nella finestra di dialogo Configure connector task, fai clic su Actions.
Seleziona l'azione DownloadFile, quindi fai clic su Fine.
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
}
```

Questo esempio scarica un file come stringa codificata in 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"}
]

Nota: se vuoi scaricare un file non binario, imposta il valore HasBytes su false.

Esempio: caricamento di un file

Nella finestra di dialogo Configure connector task, fai clic su Actions.
Seleziona l'azione UploadFile, quindi fai clic su Fine.
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"
}
```

In questo esempio vengono caricati i contenuti stringa come 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

Nella finestra di dialogo Configure connector task, fai clic su Actions.
Seleziona l'azione CopyFile, quindi fai clic su Fine.
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"
}
```

In questo esempio il file con ID 1288751886061 viene copiato 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 - Copiare una cartella

Nella finestra di dialogo Configure connector task, fai clic su Actions.
Seleziona l'azione CopyFolder, quindi fai clic su Fine.
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"
}
```

In questo esempio viene copiata la cartella con ID 218475301279 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 sull'entità

Esempio: elenca tutti i file

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

Nella finestra di dialogo Configure connector task, fai clic su Entities.
Seleziona Files dall'elenco Entity.
Seleziona l'operazione LIST, quindi fai clic su Fine.
Facoltativamente, puoi inserire valori in filterClause per filtrare l'insieme di risultati.

Esempio: ricevi un biglietto

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

Nella finestra di dialogo Configure connector task, fai clic su Entities.
Seleziona Tickets dall'elenco Entity.
Seleziona l'operazione GET, quindi fai clic su Fine.
Nella sezione Input attività dell'attività Connettori, fai clic su EntityId e inserisci 35 nel campo Valore predefinito.
Qui, 35 è il valore della chiave primaria dell'entità Tickets.

Esempio: creare un ticket

In questo esempio viene creato un ticket nell'entità Tickets.

Nella finestra di dialogo Configure connector task, fai clic su Entities.
Seleziona Tickets dall'elenco Entity.
Seleziona l'operazione Create, quindi fai clic su Fine.

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: aggiornamento di un ticket

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

Nella finestra di dialogo Configure connector task, fai clic su Entities.
Seleziona Biglietti dall'elenco Entity.
Seleziona l'operazione Update, quindi fai clic su Fine.

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
      }

Fai clic su entityId, quindi inserisci 35 nel campo Default Value (Valore predefinito).
In alternativa, anziché 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.

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

Nota: l'operazione Delete esegue solo un'eliminazione temporanea del record. Se necessario, puoi recuperare il record eliminato in un secondo momento.

Utilizzare Terraform per creare connessioni

Puoi utilizzare la risorsa Terraform per creare una nuova connessione.

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

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

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

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

Utilizzare la connessione Box in un'integrazione

Dopo aver creato 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à Connettori in Apigee Integration, consulta Attività Connettori.
Per capire come creare e utilizzare l'attività Connettori in Application Integration, consulta Attività Connettori.

Ricevi assistenza dalla community Google Cloud

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

Passaggi successivi

Scopri come sospendere e ripristinare una connessione.
Scopri come monitorare l'utilizzo dei connettori.
Scopri come visualizzare i log del connettore.