Libri Zoho

Il connettore Zoho Books consente di eseguire operazioni SQL sul sistema Zoho Books.

Versioni supportate

Il connettore sfrutta l'API Zoho Books V3 per consentire l'accesso bidirezionale ai dati di Zoho Books.

Prima di iniziare

Prima di utilizzare il connettore Zoho Books, 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:

1. Nella console Cloud, vai alla pagina Connettori di integrazione > Connessioni, quindi seleziona o crea un progetto Google Cloud.

   Vai alla pagina Connessioni

2. Fai clic su + Crea nuova 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 aree geografiche supportate, consulta la sezione Località.

   2. Fai clic su Avanti.
4. Nella sezione Dettagli connessione, completa quanto segue:
   1. Connettore: seleziona Zoho Books 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 63 caratteri.
   4. Facoltativamente, 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 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.

   Nota: puoi personalizzare i valori del nodo di connessione solo se sei un cliente con pagamento a consumo.
   7. Server degli account: l'URL completo del server dell'account.
   8. Organization Id (ID organizzazione): l'ID associato all'organizzazione Zoho Books specifica.
   9. Livello di dettaglio: il livello di dettaglio per la connessione varia da 1 a 5. Con un livello di dettaglio più elevato, verranno registrati tutti i dettagli della comunicazione (certificati di richiesta, risposta e SSL).
   10. Facoltativamente, fai clic su + Aggiungi etichetta per aggiungere un'etichetta alla connessione sotto forma di coppia chiave/valore.
   11. 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 Zoho Books supporta i seguenti tipi di autenticazione:

      • Concessione del codice di autorizzazione OAuth 2.0

   Per informazioni su come configurare questi tipi di autenticazione, consulta l'articolo Configurare l'autenticazione.

   2. Fai clic su Avanti.
6. Verifica: controlla i dettagli della connessione e dell'autenticazione.
7. Fai clic su Crea.

Configura autenticazione

Inserisci i dettagli in base all'autenticazione che vuoi utilizzare.

• Concessione del codice di autorizzazione 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.
  • Access Token (Token di accesso): secret di Secret Manager contenente il token di accesso OAuth fornito per l'app collegata 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.

Nota: puoi visualizzare le entità, le operazioni e le azioni di un connettore nell'attività Connettori.

• 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:
  • Elenca
  • Scarica
  • Crea
  • Aggiorna
  • Elimina

  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.

Nota : a tutte le entità e alle azioni è associato uno schema. Ad esempio, uno schema delle azioni contiene i dettagli dei parametri, come i nomi dei parametri e il tipo di dati corrispondente. Lo schema (metadati) per le entità e le azioni viene recuperato dalla connessione in fase di runtime dal tuo backend. Se sono presenti aggiornamenti allo schema, questi aggiornamenti non si rifletteranno automaticamente nelle connessioni esistenti. Devi aggiornare manualmente lo schema. Per aggiornare lo schema di una connessione, apri la pagina Dettagli connessione della connessione, quindi fai clic su Aggiorna schema di connessione.

Azioni

Questa sezione elenca alcune delle azioni supportate dalla connessione Zoho Books. Per capire come configurare le azioni, consulta Esempi di azioni.

Nota: i risultati di tutte le azioni saranno disponibili come risposta JSON nel parametro di risposta connectorOutputPayload dell'attività Connectors dopo aver eseguito l'integrazione.

Azione ImportCreditCardStatement

Questa azione ti consente di importare gli estratti conto del carrello dei crediti.

Parametri di input dell'azione ImportCreditCardStatement

Nome parametro	Tipo di dati	Obbligatorio	Descrizione
AccountId	String	No	ID del conto bancario o della carta di credito
TransactionsTransactionDebitOrCredit	String	No	Indica se la transazione è di debito o di credito.
TransactionsTransactionAmount	String	No	Importo coinvolto nella transazione.
TransactionsTransactionDescription	String	No	Descrizione della transazione.
TransactionsTransactionDate	String	No	Data della Transazione.

Per capire come configurare l'azione ImportCreditCardStatement, consulta gli esempi.

Esempi di azioni

In questa sezione viene descritto come eseguire alcune azioni in questo connettore.

Esempio - Importare un estratto conto della carta di credito

Questo esempio importa un estratto conto della carta di credito.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione ImportCreditCardStatement e fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value:

   {
     "AccountId": "1470449000000023015",
     "TransactionsTransactionDebitOrCredit": "credit",
     "TransactionsTransactionAmount": "200",
     "TransactionsTransactionDescription": "Transaction done from Google account",
     "TransactionsTransactionDate": "2023-05-05"
   }

Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività ImportCreditCardStatement avrà un valore simile al seguente:

[{
"Status": "Your bank statement has been imported."
}]

Esempi di operazioni con entità

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

Esempio: elenca tutte le stime

In questo esempio sono elencati tutti i record nell'entità Estimates.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Estimates dall'elenco Entity.
3. Seleziona l'operazione List e fai clic su Fine.
4. Facoltativamente, nella sezione Input attività dell'attività Connettori, puoi filtrare il set di risultati specificando una clausola di filtro. Puoi anche specificare più condizioni di filtro utilizzando gli operatori logici.

Esempio: ottenere un ordine di vendita

Questo esempio ottiene l'ordine di vendita specificato dall'entità SalesOrder.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona SalesOrder dall'elenco Entity.
3. Seleziona l'operazione Get e fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su EntityId (ID entità), quindi inserisci 1470449000000043003 nel campo Valore predefinito.

   In questo caso, 1470449000000043003 è un valore di chiave primaria nell'entità SalesOrder.

Esempio: creare una transazione bancaria

Questo esempio crea un record di transazione bancaria nell'entità BankTransactions.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona BankTransactions 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 inserisci un valore simile al seguente nel campo Default Value:

   {
   "TransactionType": "transfer_fund",
   "FromAccountId": "1470449000000000459",
   "ToAccountId": "1470449000000110001",
   "Amount": 45.0,
   "CurrencyId": "1470449000000000064"
   }

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

   {
   "TransactionId": "1470449000000231005"
   }

Esempio: aggiornare i dati di contatto del cliente

Questo esempio aggiorna il record del cliente specificato nell'entità CustomerContacts.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona CustomerContacts 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 inserisci un valore simile al seguente nel campo Default Value:

   {
   "Department": "Development",
   "ContactId": "1470449000000038003"
   }

5. Nella sezione Input attività dell'attività Connettori, fai clic su entityId e inserisci 1470449000000038005 nel campo Valore predefinito.

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

{
"CustomerContactId": "1470449000000038005"
}

Esempio - Eliminare il record di una fattura

Questo esempio elimina il record della fattura specificato nell'entità InvoiceDetails.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona InvoiceDetails 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, quindi inserisci 1470449000000184001 nel campo Valore predefinito.

Nota: se l'entità ha una chiave primaria composita, puoi specificare una clausola di filtro.

Utilizzare la connessione Zoho Books 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.