Zuora
Il connettore Zuora ti consente di connetterti a un'istanza Zuora e accedere ai dati Zuora come un database tradizionale.
Versioni supportate
Questo connettore utilizza la versione v1 dell'API Zuora per abilitare l'accesso bidirezionale a Zuora.
Prima di iniziare
Prima di utilizzare il connettore Zuora, 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:
- Nella console Cloud, vai alla pagina Connettori di integrazione > Connessioni, quindi seleziona o crea un progetto Google Cloud.
- Fai clic su + Crea nuova per aprire la pagina Crea connessione.
- Nella sezione Posizione, scegli la località per la connessione.
- Regione: seleziona una località dall'elenco a discesa.
Le regioni supportate per i connettori includono:
Per l'elenco di tutte le aree geografiche supportate, consulta la sezione Località.
- Fai clic su Avanti.
- Regione: seleziona una località dall'elenco a discesa.
- Nella sezione Dettagli connessione, completa quanto segue:
- Connettore: seleziona Zuora dall'elenco a discesa dei connettori disponibili.
- Versione connettore: seleziona la versione del connettore dall'elenco a discesa delle versioni disponibili.
- 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.
- Facoltativamente, inserisci una descrizione per l'istanza di connessione.
- Account di servizio: seleziona un account di servizio con i ruoli richiesti.
- 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.
- Tenant: impostalo sul tenant di Zuora. Per impostazione predefinita, utilizziamo il tenant "USProduction".
- URL: è obbligatorio solo nel caso in cui tu abbia un ambiente di copia di produzione statunitense. Se viene fornita questa proprietà, il valore della proprietà tenant non ha alcun effetto sul processo di autenticazione.
- ZuoraService: specifica il servizio o lo schema di esecuzione da utilizzare
- Use Client Side Paging (Usa il paging lato client): indica se il provider ADO.NET CData per SAP Cloud for Customer deve utilizzare o meno il paging lato client.
- Utilizza servizio personalizzato: indica se deve essere utilizzato il servizio OData personalizzato SAP Cloud for Customer.
- Visualizzazioni definite dall'utente: un percorso file che rimanda al file di configurazione JSON contenente le viste personalizzate.
- Facoltativamente, fai clic su + Aggiungi etichetta per aggiungere un'etichetta alla connessione sotto forma di coppia chiave/valore.
- Fai clic su Avanti.
-
Nella sezione Autenticazione, inserisci i dettagli di autenticazione.
- Seleziona un Tipo di autenticazione e inserisci i dettagli pertinenti.
La connessione Zuora supporta i seguenti tipi di autenticazione:
- Credenziali client OAuth 2.0
- Fai clic su Avanti.
Per informazioni su come configurare questi tipi di autenticazione, consulta l'articolo Configurare l'autenticazione.
- Seleziona un Tipo di autenticazione e inserisci i dettagli pertinenti.
- Verifica: controlla i dettagli della connessione e dell'autenticazione.
- Fai clic su Crea.
Configura autenticazione
Inserisci i dettagli in base all'autenticazione che vuoi utilizzare.
-
Credenziali client OAuth 2.0
- 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.
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.
Esempi di operazioni con entità
Questa sezione mostra come eseguire alcune delle operazioni relative alle entità in questo connettore.
Esempio: elenca tutti i dati registrati in Rimborsi
In questo esempio sono elencati tutti i record nell'entità Refunds
.
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona
Refunds
dall'elencoEntity
. - Seleziona l'operazione
List
e fai clic su Fine. - Facoltativamente, nella sezione Input attività dell'attività Connettori, puoi filtrare il set di risultati specificando una clausola di filtro.
Esempio: visualizzare una nota di addebito
Questo esempio ottiene un record il cui ID è 45
dall'entità Debit_Memo
.
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona
Debit_Memo
dall'elencoEntity
. - Seleziona l'operazione
Get
e fai clic su Fine. - Nella sezione Input attività dell'attività Connettori, fai clic su EntityId (ID entità), quindi inserisci
45
nel campo Valore predefinito.In questo caso,
45
è un valore di chiave primaria nell'entitàDebit_Memo
.
Esempio: creare un ticket
Questo esempio crea un ticket nell'entità Ticket
.
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona
Tickets
dall'elencoEntity
. - Seleziona l'operazione
Create
e fai clic su Fine. - Nella sezione Input attività dell'attività Connettori, fai clic su
connectorInputPayload
e inserisci un valore simile al seguente nel campoDefault Value
:{ "Name": "Test735362767", "Label": "Test735362767", "Type": "String", "FieldType": "Insert ticket1", "GroupName": "ticketinformation", "Description": "Test ticket" }
Se l'integrazione ha esito positivo, il campo
connectorOutputPayload
dell'attività del connettore avrà un valore simile al seguente:{ "Name": "Test1695971640609" }
Esempio: aggiornare una voce relativa a deal
Questo esempio aggiorna il record il cui ID è 97 nell'entità Deals
.
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona
Deals
dall'elencoEntity
. - Seleziona l'operazione
Update
e fai clic su Fine. - Nella sezione Input attività dell'attività Connettori, fai clic su
connectorInputPayload
e inserisci un valore simile al seguente nel campoDefault Value
:{ "Description": "New description" }
- Fai clic su entityId e inserisci
97
nel campo Default Value (Valore predefinito).In alternativa, invece di specificare entityId, puoi anche impostare filterClause su
97
.
Esempio - Eliminare un modulo
Questo esempio elimina il record il cui ID è 78 nell'entità Forms
.
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona
Forms
dall'elencoEntity
. - Seleziona l'operazione
Delete
e fai clic su Fine. - Nella sezione Input attività dell'attività Connettori, fai clic su entityId, quindi inserisci
78
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 |
---|---|---|---|
tenant | ENUM | False | Impostalo sul tenant di Zuora. Per impostazione predefinita, utilizziamo il tenant "USProduction". I valori supportati sono: USProduction, USAPISandbox, USPerformanceTest, EUProduction, EUSandbox, EUCentralSandbox, USCloudProduction, USCloudAPISandbox, USCentralSandbox |
url | STRING | False | Questa operazione è necessaria solo nel caso in cui tu abbia un ambiente di produzione negli Stati Uniti. Se viene fornita questa proprietà, il valore della proprietà tenant non ha alcun effetto sul processo di autenticazione. |
zuora_service | ENUM | False | Specifica il servizio o lo schema di esecuzione da utilizzare. I valori supportati sono: DataQuery, AQuADataExport |
use_client_side_paging | BOOLEANO | False | Indica se il provider CData ADO.NET per SAP Cloud for Customer deve utilizzare il paging lato client. |
use_custom_service | BOOLEANO | False | Indica se deve essere utilizzato il servizio SAP Cloud for Customer OData personalizzato. |
user_defined_views | STRING | False | Un percorso file che rimanda al file di configurazione JSON contenente le viste personalizzate. |
Utilizzare la connessione Zuora 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
- Scopri come sospendere e ripristinare una connessione.
- Scopri come monitorare l'utilizzo dei connettori.
- Scopri come visualizzare i log del connettore.