Zuora

Il connettore Zuora ti consente di connetterti a un'istanza Zuora e di accedere ai dati di Zuora come a un database tradizionale.

Versioni supportate

Questo connettore sfrutta la versione 1 dell'API Zuora per consentire l'accesso bidirezionale a Zuora.

Prima di iniziare

Prima di utilizzare il connettore Zuora, svolgi le seguenti attività:

  • Nel tuo progetto Google Cloud:
    • Assicurati che la connettività di rete sia configurata. Per informazioni sui pattern di rete, consulta Connettività di rete.
    • 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 eseguire l'autenticazione ed essere autorizzato ad accedere ai dati nelle API Google. Se non hai un account di servizio, devi crearne uno. Per maggiori informazioni, consulta Creare un account di servizio.

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

      Per scoprire come attivare i servizi, consulta Abilitazione dei servizi.

    Se questi servizi o autorizzazioni non sono stati attivati in precedenza per il tuo progetto, ti verrà chiesto di attivarli durante la configurazione del connettore.

Configura il connettore

Per configurare il connettore devi creare una connessione all'origine dati (sistema di backend). Una connessione è specifica per un'origine dati. Ciò significa che se hai molte origini dati, devi creare una connessione distinta per ciascuna. Per creare una connessione:

  1. Nella console Cloud, vai alla pagina Connettori di integrazione > Connessioni e 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 Località, scegli la località della connessione.
    1. Regione: seleziona una località dall'elenco a discesa.

      Le regioni supportate per i connettori includono:

      Per l'elenco di tutte le regioni supportate, consulta Località.

    2. Fai clic su Avanti.
  4. Nella sezione Dettagli connessione, completa quanto segue:
    1. Connettore: seleziona Zuora dall'elenco a discesa dei connettori disponibili.
    2. Versione del 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 49 caratteri.
    4. (Facoltativo) Inserisci una Descrizione per l'istanza di connessione.
    5. Se vuoi, attiva Cloud Logging e poi seleziona un livello di log. Per impostazione predefinita, il livello di log è impostato su Error.
    6. Account di servizio: seleziona un account di servizio con i ruoli richiesti.
    7. (Facoltativo) 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. Per elaborare più transazioni per una connessione sono necessari più nodi e, al contrario, sono necessari meno nodi per elaborare meno transazioni. Per capire in che modo i nodi influiscono sui prezzi dei connettori, consulta Prezzi per i nodi di connessione. Se non inserisci alcun valore, per impostazione predefinita il numero minimo di nodi è impostato su 2 (per una maggiore disponibilità) e il numero massimo di nodi è impostato su 50.

    8. Tenant: imposta il tuo tenant Zuora. Per impostazione predefinita utilizziamo il tenant "USProduction".
    9. URL: questo campo è obbligatorio solo se hai un ambiente di copia di produzione negli Stati Uniti. Se viene fornita questa proprietà, il valore della proprietà Tenant non ha alcun effetto sulla procedura di autenticazione.
    10. ZuoraService: specifica quale servizio o schema di esecuzione utilizzare
    11. Utilizza la paginazione lato client: indica se il provider ADO.NET CData per SAP Cloud for Customer deve utilizzare la paginazione lato client.
    12. Utilizza servizio personalizzato: indica se deve essere utilizzato il servizio OData SAP Cloud for Customer personalizzato.
    13. Visualizzazioni definite dall'utente: un percorso che rimanda al file di configurazione JSON contenente le visualizzazioni personalizzate.
    14. Se vuoi, fai clic su + Aggiungi etichetta per aggiungere un'etichetta alla connessione sotto forma di coppia chiave/valore.
    15. 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 Zuora supporta i seguenti tipi di autenticazione:

      • Credenziali client OAuth 2.0

      2. Per capire come configurare questi tipi di autenticazione, consulta Configurare l'autenticazione.

    2. Fai clic su Avanti.
  6. Rivedi: controlla i dettagli di connessione e autenticazione.
  7. Fai clic su Crea.

Configura autenticazione

Per attivare l'autenticazione delle credenziali client OAuth 2.0:

  1. Crea le credenziali del client in Zuora e ottieni l'ID client e il client secret.
  2. Specifica le credenziali in Google Cloud.

Creare le credenziali client in Zuora

  1. Nel portale OneID, fai clic sul tuo avatar e poi su Impostazioni.
  2. Fai clic su Gestisci client OAuth 2.0.
  3. Nella pagina Gestisci client OAuth 2.0, fai clic su Nuovo.
  4. Nella finestra Nuovo client OAuth 2.0, specifica i seguenti campi:
    • Nome: inserisci un nome per il client.
    • Tipo: seleziona Credenziali client dall'elenco.
  5. Fai clic su Salva. Una volta creato il client, viene visualizzata una finestra con l'ID client e il client secret.

    Salva l'ID client e il client secret per utilizzarli in un secondo momento. Per ulteriori informazioni, consulta Gestire i client OAuth 2.0 .

Specifica le credenziali in Google Cloud

Quando crei la connessione in Integration Connectors , devi specificare i seguenti dettagli:

Nella sezione Autenticazione, inserisci i seguenti dettagli:

  • ID client: l'ID client dell'app che hai creato.
  • Client secret: il secret di Secret Manager contenente il client secret per l'app collegata che hai creato.

Tipo di connessione web

La seguente tabella elenca i valori di configurazione di esempio per il tipo di connessione web Zuora:

Nome campo Dettagli
Località us-central1
Connettore Zuora
Versione del connettore 1
Nome collegamento zuora-con
Account di servizio account@my-project.iam.gserviceaccount.com
Tenant TENANT
Numero minimo di nodi 2
Numero massimo di nodi 4
ID client CLIENT_ID
Client secret CLIENT_SECRET
Versione secret 1

Entità, operazioni e azioni

Tutti i connettori di integrazione forniscono un livello di astrazione per gli oggetti dell'applicazione collegata. Puoi accedere agli oggetti di un'applicazione solo tramite questa astrazione. L'astrazione viene mostrata come entità, operazioni e azioni.

  • Entità : un'entità può essere considerata un oggetto o una raccolta di proprietà nell'applicazione o nel servizio collegato. La definizione di un'entità varia da un connettore all'altro. 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à. Puoi eseguire su un'entità una delle seguenti operazioni:

    La selezione di un'entità dall'elenco disponibile genera un elenco di operazioni disponibili per l'entità. Per una descrizione dettagliata delle operazioni, consulta le operazioni sulle entità dell'attività Connettori. Tuttavia, se un connettore non supporta nessuna delle operazioni sulle entità, queste operazioni non supportate non sono elencate nell'elenco Operations.

  • Azione : un'azione è una funzione di prima classe resa disponibile all'integrazione tramite l'interfaccia del connettore. Un'azione ti consente di apportare modifiche a una o più entità e varia da un connettore all'altro. In genere, 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 sulle entità

Questa sezione mostra come eseguire alcune delle operazioni sulle entità in questo connettore.

Esempio: elenca tutti i record in Rimborsi

Questo esempio elenca tutti i record nell'entità Refunds.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Refunds dall'elenco Entity.
  3. Seleziona l'operazione List e poi fai clic su Fine.
  4. Se vuoi, nella sezione Input dell'attività dell'attività Connettori, puoi filtrare il set di risultati specificando una clausola di filtro.

Esempio: ottieni un record di nota di addebito

Questo esempio recupera un record il cui ID è 45 dall'entità Debit_Memo.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Debit_Memo dall'elenco Entity.
  3. Seleziona l'operazione Get e poi fai clic su Fine.
  4. Nella sezione Input dell'attività dell'attività Connettori, fai clic su EntityId e poi inserisci 45 nel campo Valore predefinito.

    Qui, 45 è un valore della chiave primaria nell'entità Debit_Memo.

Esempio: crea un ticket

Questo esempio crea un ticket nell'entità Ticket.

  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 poi inserisci un valore simile al seguente nel Default Value campo: 
    {
"Name": "Test735362767",
"Label": "Test735362767",
"Type": "String",
"FieldType": "Insert ticket1",
"GroupName": "ticketinformation",
"Description": "Test ticket"
}

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

    {
"Name": "Test1695971640609"
}

Esempio: aggiorna una voce dei deal

Questo esempio aggiorna il record il cui ID è 97 nell'entità Deals.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Deals 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 poi inserisci un valore simile al seguente nel Default Value campo: 
    {
"Description": "New description"
}
  5. Fai clic su entityId e inserisci 97 nel campo Valore predefinito.

    In alternativa, anziché specificare entityId, puoi anche impostare filterClause su 97.

Esempio: eliminare un modulo

Questo esempio elimina il record il cui ID è 78 nell'entità Forms.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Forms 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 e poi 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, consulta Comandi Terraform di base.

Per visualizzare un modello Terraform di esempio per la creazione di una connessione, consulta 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
tenant ENUM Falso Imposta questo valore sul tuo tenant Zuora. Per impostazione predefinita utilizziamo il tenant "USProduction". I valori supportati sono: USProduction, USAPISandbox, USPerformanceTest, EUProduction, EUSandbox, EUCentralSandbox, USCloudProduction, USCloudAPISandbox, USCentralSandbox
url STRING Falso Questo è necessario solo se hai un ambiente di produzione di copie negli Stati Uniti. Se viene fornita questa proprietà, il valore della proprietà Tenant non ha alcun effetto sulla procedura di autenticazione.
zuora_service ENUM Falso Specifica quale servizio o schema di esecuzione utilizzare. I valori supportati sono: DataQuery, AQuADataExport
use_client_side_paging BOOLEANO Falso Indica se il provider ADO.NET CData per SAP Cloud for Customer deve utilizzare la paginazione lato client.
use_custom_service BOOLEANO Falso Indica se è necessario utilizzare il servizio OData SAP Cloud for Customer personalizzato.
visualizzazioni_definite_dall'utente STRING Falso Un percorso file che rimanda al file di configurazione JSON contenente le visualizzazioni personalizzate.

Utilizzare la connessione Zuora in un'integrazione

Una volta creata, la connessione diventa disponibile sia nell'integrazione Apigee sia nell'integrazione delle applicazioni. Puoi utilizzare la connessione in un'integrazione tramite l'attività Connettori.

  • Per informazioni su come creare e utilizzare l'attività Connectors in Apigee Integration, consulta Attività Connectors.
  • Per informazioni su come creare e utilizzare l'attività Connettori in Application Integration, consulta Attività Connettori.

Ricevere assistenza dalla community Google Cloud

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

Passaggi successivi