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:
    • Concedi il ruolo IAM roles/connectors.admin all'utente. configurazione del 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 una persona non umana utente che deve autenticarsi e avere l'autorizzazione ad accedere ai dati nelle API di 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 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 chiesto di abilitarli durante la configurazione del connettore.

Configura il connettore

Per configurare il connettore è necessario creare una connessione al tuo origine dati (sistema di backend). Una connessione è specifica per un'origine dati. it significa che se hai molte origini dati, devi creare una connessione separata per ogni origine dati. Per creare una connessione:

  1. Nella console Cloud, vai a Connettori di integrazione > Pagina Connessioni e poi selezionare o creare 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.

      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 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. Facoltativamente, 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. 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, meno nodi per elaborare meno transazioni. Per comprendere 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 "USProduction" tenant.
    9. 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 sulla procedura di autenticazione.
    10. ZuoraService: specifica quale servizio o schema di esecuzione utilizzare
    11. 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.
    12. Utilizza servizio personalizzato: indica se deve essere utilizzato il servizio OData personalizzato SAP Cloud for Customer.
    13. Visualizzazioni definite dall'utente: un percorso file che rimanda al file di configurazione JSON contenente le viste 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 informazioni su come configurare questi tipi di autenticazione, consulta l'articolo Configurare l'autenticazione.

    2. Fai clic su Avanti.
  6. Rivedi: controlla i dettagli di connessione e autenticazione.
  7. 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 l'applicazione connessa. 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à differisce da un connettore di rete. Ad esempio, in un connettore di database, le tabelle sono le entità, connettore 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 è possibile eseguire su un'entità. Puoi eseguire una qualsiasi 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 nessuna delle operazioni relative all'entità, come quelle non supportate operazioni 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. Normalmente, un'azione ha alcuni parametri di input e un output . Tuttavia, è possibile che un connettore non supporta alcuna azione, nel qual caso l'elenco Actions sarà vuoto.

Esempi di operazioni con entità

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

Esempio: elenca tutti i record in Rimborsi

In questo esempio sono elencati 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 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: visualizzare una 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.

    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.

  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 è andata a buon fine, 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, quindi inserisci un valore simile al seguente nella Campo Default Value: 
    {
"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 il comando Terraform risorsa 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 di Terraform:

Nome parametro Tipo di dati Obbligatorio Descrizione
tenant ENUM Falso 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 Falso 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 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 CData ADO.NET per SAP Cloud for Customer deve utilizzare il paging lato client.
use_custom_service BOOLEANO Falso Indica se deve essere utilizzato il servizio SAP Cloud for Customer OData 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

Dopo aver creato la connessione, questa diventa disponibile in Apigee Integration e Application Integration. Puoi utilizzare 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 informazioni su 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 ai forum Cloud.

Passaggi successivi