ZohoBooks

Il connettore ZohoBooks consente di eseguire operazioni SQL sul sistema ZohoBooks.

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, svolgi 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 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 le informazioni, vedi Creazione di un account di servizio.

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

    Per informazioni su 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 è 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 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 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 i seguenti passaggi:
   1. Connettore: seleziona Zoho Books 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. Facoltativamente, abilita 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, 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.

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

• Concessione del codice di autorizzazione OAuth 2.0
  • ID client: l'ID client fornito dal connettore per l'app che hai creato.
  • Client secret: il segreto di Secret Manager contenente il client secret per l'app collegata 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.

Configurare l'autenticazione di ZohoBooks

Le sezioni seguenti descrivono come configurare il connettore ZohoBooks.

Configurare un account ZohoBooks

Per ulteriori informazioni sulla configurazione dell'account ZohoBooks, vedi Creazione dell'account.

Configurare un account sviluppatore e creare un'app client

Per informazioni sulla creazione dell'account sviluppatore ZohoBooks e dell'app client, consulta Creazione dell'app client.

Configura l'autenticazione

Per configurare l'autenticazione:

1. Vai alla pagina Connettori di integrazione nella console Cloud.
2. Per visualizzare i dettagli di una connessione specifica, fai clic sul nome della connessione nella tabella delle connessioni esistenti.
3. Nella sezione Autenticazione, fai clic su Autorizza connessione per avviare la procedura di autorizzazione.
4. Copia l'URI di reindirizzamento.
5. Vai alla Console per gli sviluppatori di ZohoBooks.
6. Nella sezione URI di reindirizzamento autorizzati del client dell'applicazione basato su servizio, aggiungi l'URI di reindirizzamento.
7. Nella pagina Connettori di integrazione, vai alla pagina di connessione di ZohoBooks da cui hai copiato l'URI di reindirizzamento e fai clic su Autorizza.

Si aprirà il sito di ZohoBooks per l'autorizzazione.

Esempi di configurazione delle connessioni

Questa sezione elenca i valori di esempio per i vari campi che configuri durante la creazione della connessione a Zoho Books.

Tipo di connessione web

Nome campo	Dettagli
Regione	us-east4
Connettore	ZohoBooks
Versione del connettore	1
Nome collegamento	zohobooks-google-cloud-conn
Account di servizio	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Server degli account	https://books.zoho.in
ID organizzazione	ORGANIZATION_ID
Preferenze di lettura	5
Numero minimo di nodi	2
Numero massimo di nodi	50
ID client	CLIENT_ID
Ambiti	ZohoBooks.fullaccess.all
Client secret	CLIENT_SECRET
Versione secret	1

Utilizzare il collegamento ZohoBooks in un'integrazione

Una volta creata, la connessione diventa disponibile sia nell'integrazione Apigee sia nell'integrazione delle applicazioni. 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 informazioni su come creare e utilizzare l'attività Connettori in Application Integration, consulta Attività Connettori.

Entità, operazioni e azioni

Tutti gli Integration Connectors forniscono un livello di astrazione per gli oggetti dell'applicazione collegata. 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 nell'attività Connettori.

• 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à, 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 disponga di entità. In questo caso, L'elenco Entities sarà vuoto.

• Operazione: un'operazione è l'attività che puoi eseguire su un'entità. Puoi eseguire una qualsiasi delle seguenti operazioni su un'entità:
  • Elenca
  • Scarica
  • Crea
  • Aggiorna
  • Elimina

  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 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 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 avrà i dettagli dei parametri, come ad esempio il parametro e il tipo di dati corrispondente. Lo schema (metadati) per le entità e le azioni viene recuperato dalla connessione al runtime dal tuo backend. In caso di aggiornamenti allo schema, questi aggiornamenti non saranno si riflette automaticamente sulle connessioni esistenti; devi aggiornare manualmente lo schema. Per aggiornare lo schema di una connessione, apri la pagina Dettagli connessione della connessione e fai clic su Aggiorna lo 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 sotto forma di Risposta JSON in connectorOutputPayload dell'attività Connectors dopo aver eseguito l'integrazione.

Azione ImportCreditCardStatement

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

Parametri di input dell'azione ImportCreditCardStatement

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

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

Esempi di azioni

Questa sezione descrive come eseguire alcune delle 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 poi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi 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 viene eseguita correttamente, 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 sulle 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 filtra il set di risultati specificando una clausola di filtro. Puoi anche specificare più condizioni di filtro utilizzando gli operatori logici.

Esempio: ricevi 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 poi fai clic su Fine.
4. Nella sezione Input dell'attività dell'attività Connettori, fai clic su EntityId e poi 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, quindi inserisci un valore simile al seguente nella 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 simile al seguente:

   {
   "TransactionId": "1470449000000231005"
   }

Esempio: aggiornare i dati di contatto del cliente

Questo esempio aggiorna il record 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, quindi inserisci un valore simile al seguente nella Campo Default Value:

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

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

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

{
"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 e poi inserisci 1470449000000184001 nel campo Valore predefinito.

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

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

• Scopri come sospendere e riprendere una connessione.
• Scopri come monitorare l'utilizzo dei connettori.
• Scopri come visualizzare i log del connettore.