Zuora

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

Versioni supportate

Questo connettore utilizza la versione v1 dell'API Zuora per consentire l'accesso bidirezionale a Zuora.

Prima di iniziare

Prima di utilizzare il connettore Zuora, esegui le seguenti operazioni:

  • 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 al 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 di Google. Se non hai un account di servizio, devi crearne uno. Per maggiori informazioni, vedi Creare un service account.

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

      Per capire come abilitare i servizi, consulta Abilitazione dei servizi.

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

Configura il connettore

Una connessione è specifica per un'origine dati. Ciò significa che se hai molte origini dati, devi creare una connessione separata per ciascuna origine dati. Per creare una connessione:

  1. Nella console Cloud, vai alla pagina Integration Connectors > Connessioni e poi 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à per la 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 contenere più di 49 caratteri.
    4. (Facoltativo) Inserisci una Descrizione per l'istanza di connessione.
    5. (Facoltativo) Abilita Cloud Logging, quindi seleziona un livello di log. Per impostazione predefinita, il livello di log è impostato su Error.
    6. Service Account: 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. Sono necessari più nodi per elaborare più transazioni per una connessione e, viceversa, sono necessari meno nodi per elaborare meno transazioni. Per capire in che modo i nodi influiscono sui prezzi dei connettori, consulta la sezione Prezzi dei nodi di connessione. Se non inserisci alcun valore, per impostazione predefinita i nodi minimi sono impostati su 2 (per una migliore disponibilità) e i nodi massimi su 50.

    8. Tenant: imposta questo valore sul tuo tenant Zuora. Per impostazione predefinita, utilizziamo il tenant "USProduction".
    9. URL: questo campo è obbligatorio solo se hai un ambiente di copia di produzione statunitense. Se questa proprietà viene fornita, il valore della proprietà Tenant non ha alcun effetto sulla procedura di autenticazione.
    10. ZuoraService: specifica il servizio o lo schema di esecuzione da utilizzare
    11. Utilizza la paginazione lato client: indica se il provider CData ADO.NET 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. User Defined Views (Viste definite dall'utente): un percorso del file che punta al file di configurazione JSON contenente le tue viste personalizzate.
    14. (Facoltativo) 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: rivedi i dettagli di connessione e autenticazione.
  7. Fai clic su Crea.

Configura l'autenticazione

Per attivare l'autenticazione con credenziali client OAuth 2.0:

  1. Crea le credenziali 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 correttamente 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: secret di Secret Manager contenente il client secret per l'app connessa 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
Service account 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 connessa. Puoi accedere agli oggetti di un'applicazione solo tramite questa astrazione. L'astrazione ti 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 connesso. 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 del file server, le cartelle sono le entità e in un connettore del 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 una delle seguenti operazioni su un'entità:

    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 sulle entità dell'attività Connettori. Tuttavia, se un connettore non supporta alcuna delle operazioni sulle entità, queste operazioni non supportate non sono elencate nell'elenco Operations.

  • Azione: un'azione è una funzione di prima classe resa disponibile per l'integrazione tramite l'interfaccia del connettore. Un'azione ti consente di apportare modifiche a una o più entità e varia da connettore a connettore. In genere, un'azione ha 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, quindi fai clic su Fine.
  4. (Facoltativo) Nella sezione Input attività dell'attività Connettori, puoi filtrare il set di risultati specificando una clausola di filtro.

Esempio: recuperare 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, quindi fai clic su Fine.
  4. Nella sezione Input attività dell'attività Connettori, fai clic su EntityId e poi inserisci 45 nel campo Valore predefinito.

    In questo caso, 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, quindi 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 campo Default 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: aggiorna una voce di deal

Questo esempio aggiorna il record con 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, quindi 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 campo Default Value: 
    {
"Description": "New description"
}
  5. Fai clic su entityId, quindi 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 con 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, quindi fai clic su Fine.
  4. Nella sezione Input attività dell'attività Connettori, fai clic su entityId e poi inserisci 78 nel campo Valore predefinito.

Creare connessioni utilizzando Terraform

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 della connessione, consulta 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 elemento 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 È obbligatorio solo se hai un ambiente di copia di produzione statunitense. Se questa proprietà viene fornita, il valore della proprietà Tenant non ha alcun effetto sulla procedura di autenticazione.
zuora_service ENUM Falso Specifica quale servizio di esecuzione o schema utilizzare. I valori supportati sono: DataQuery, AQuADataExport
use_client_side_paging BOOLEANO Falso Indica se il provider CData ADO.NET per SAP Cloud for Customer deve utilizzare la paginazione lato client.
use_custom_service BOOLEANO Falso Indica se deve essere utilizzato il servizio OData SAP Cloud for Customer personalizzato.
user_defined_views STRING Falso Un percorso file che punta al file di configurazione JSON contenente le visualizzazioni personalizzate.

Utilizzare la connessione Zuora in un'integrazione

Una volta creata la connessione, questa diventa disponibile sia in Apigee Integration che in Application Integration. Puoi utilizzare 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.

Ricevere assistenza dalla community Google Cloud

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

Passaggi successivi