ZohoBooks

Il connettore ZohoBooks ti 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, esegui le seguenti attività:

  • Nel tuo progetto Google Cloud:
    • Assicurati che la connettività di rete sia configurata. Per informazioni sui pattern di rete, vedi 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. Il connettore e il account di servizio devono appartenere allo stesso progetto. Per ulteriori 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 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. Per creare una connessione:

  1. Nella console Google 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 Posizione, scegli la posizione 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 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 superare i 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 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 sono impostati su 50.

    8. Server degli account: l'URL completo del server degli account.
    9. ID organizzazione: l'ID associato all'organizzazione Zoho Books specifica.
    10. Livello di dettaglio: livello di dettaglio per la connessione, varia da 1 a 5. Un livello di dettaglio più elevato registra tutti i dettagli della comunicazione (richiesta,risposta e certificati SSL).
    11. (Facoltativo) 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

      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

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.
    • Token di accesso: secret di Secret Manager contenente il token di accesso OAuth fornito per l'app connessa che hai creato.

Configurare l'autenticazione di Zoho Books

Le sezioni seguenti descrivono come configurare il connettore ZohoBooks.

Configurare un account Zoho Books

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, vedi Creazione dell'app client.

Configura l'autenticazione

Per configurare l'autenticazione:

  1. Vai alla pagina Integration Connectors nella console Cloud.
  2. Per visualizzare i dettagli di una connessione specifica, fai clic sul nome di una 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 sviluppatori di Zoho Books.
  6. Nella sezione URI di reindirizzamento autorizzati del client dell'applicazione basata 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.

    8. Vieni reindirizzato al sito ZohoBooks per l'autorizzazione.

Esempi di configurazione della connessione

Questa sezione elenca i valori di esempio per i vari campi che configuri quando crei la connessione Zoho Books.

Tipo di connessione web

Nome campo Dettagli
Regione us-east4
Connettore ZohoBooks
Versione del connettore 1
Nome collegamento zohobooks-google-cloud-conn
Service account 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 la connessione ZohoBooks 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, vedi Attività Connettori.

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.

Azioni

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

Azione ImportCreditCardStatement

Questa azione ti consente di importare gli estratti conto della carta di credito.

Parametri di input dell'azione ImportCreditCardStatement

Nome parametro Tipo di dati Obbligatorio Descrizione
AccountId Stringa No ID del conto bancario/della carta di credito
TransactionsTransactionDebitOrCredit Stringa No Indica se la transazione è di debito o di credito.
TransactionsTransactionAmount Stringa No Importo coinvolto nella 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: importa 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, quindi 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"
}

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

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

Esempi di operazioni sulle entità

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

Esempio: elencare tutte le stime

Questo esempio elenca 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, 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. Puoi anche specificare più condizioni di filtro utilizzando gli operatori logici.

Esempio: ottieni un ordine di vendita

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

    In questo caso, 1470449000000043003 è un valore della 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, 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: 
    {
"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 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, 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: 
    {
"Department": "Development",
"ContactId": "1470449000000038003"
}
  5. Nella sezione Input attività dell'attività Connettori, fai clic su entityId e poi inserisci 1470449000000038005 nel campo Valore predefinito.

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

    {
"CustomerContactId": "1470449000000038005"
}

Esempio: elimina un record di 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, quindi fai clic su Fine.
  4. Nella sezione Input attività dell'attività Connettori, fai clic su entityId e poi inserisci 1470449000000184001 nel campo Valore predefinito.

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