QuickBooks Online

Il connettore QuickBooks Online ti consente di eseguire operazioni di inserimento, eliminazione, aggiornamento e lettura sul database QuickBooks.

Prima di iniziare

Prima di utilizzare il connettore QuickBooks Online, svolgi le seguenti attività:

• 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 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, consulta Creare un account di servizio.

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

    Per scoprire 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 devi creare una connessione all'origine dati (sistema di backend). Una connessione è specifica per un'origine dati. Ciò significa che se hai molte origini dati, devi creare una connessione distinta per ciascuna. Per creare una connessione:

1. Nella console Cloud, vai alla pagina Connettori di integrazione > Connessioni e 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à della connessione.
   1. Regione: seleziona una località dall'elenco a discesa.

      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 QuickBooks 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. Account di servizio: seleziona un account di servizio con i ruoli richiesti.
   6. (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. Per elaborare più transazioni per una connessione sono necessari più nodi e, al contrario, sono necessari meno nodi 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.
   7. ID azienda: fornisci l'ID azienda dell'app registrata nel portale per sviluppatori di Intuit.
   8. Se vuoi, inserisci un codice paese per la versione di QuickBooks Online in uso.
   9. Se vuoi, inserisci una versione minore da utilizzare quando invii richieste all'API QuickBooks Online.
   10. Utilizza la sandbox: fai clic sulla casella di controllo se utilizzi un account sandbox.
   11. Utilizza proxy: seleziona questa casella di controllo per configurare un server proxy per la connessione e configura i seguenti valori:
   • Schema di autenticazione proxy: seleziona il tipo di autenticazione per l'autenticazione con il server proxy. Sono supportati i seguenti tipi di autenticazione:
     • Di base: autenticazione HTTP di base.
     • Digest: autenticazione HTTP Digest.
   • Utente proxy: un nome utente da utilizzare per l'autenticazione con il server proxy.
   • Password proxy: il segreto di Secret Manager della password dell'utente.
   • Tipo SSL proxy: il tipo di SSL da utilizzare per la connessione al server proxy. Sono supportati i seguenti tipi di autenticazione:
     • Automatico: impostazione predefinita. Se l'URL è un URL HTTPS, viene utilizzata l'opzione Tunnel. Se l'URL è un URL HTTP, viene utilizzata l'opzione MAI.
     • Sempre: la connessione è sempre abilitata per SSL.
     • Mai: la connessione non è abilitata per SSL.
     • Tunnel: la connessione avviene tramite un proxy di tunneling. Il server proxy apre una connessione all'host remoto e il traffico fluisce avanti e indietro attraverso il proxy.
   • Nella sezione Server proxy, inserisci i dettagli del server proxy.
     1. Fai clic su + Aggiungi destinazione.
     2. Seleziona un Tipo di destinazione.
        • Indirizzo host: specifica il nome host o l'indirizzo IP della destinazione.

          Se vuoi stabilire una connessione privata al tuo sistema di backend:

          • Crea un collegamento del servizio PSC.
          • Crea un collegamento dell'endpoint e poi inserisci i dettagli del collegamento dell'endpoint nel campo Indirizzo host.
   12. Se vuoi, fai clic su + AGGIUNGI ETIQUETTA per aggiungere un'etichetta alla connessione sotto forma di coppia chiave/valore.
   13. Fai clic su AVANTI.
5. Nella sezione Destinazioni, inserisci i dettagli dell'host remoto (sistema di backend) a cui vuoi connetterti.
   1. Tipo di destinazione: seleziona un Tipo di destinazione.
      • Seleziona Indirizzo host dall'elenco per specificare il nome host o l'indirizzo IP della destinazione.
      • Se vuoi stabilire una connessione privata ai tuoi sistemi di backend, seleziona Allegato endpoint dall'elenco, quindi seleziona l'allegato endpoint richiesto dall'elenco Allegato endpoint.
        Nota: per capire come creare un collegamento endpoint, consulta Collegamento del servizio PSC e Collegamento endpoint. Una volta creato, il collegamento dell'endpoint sarà visibile nell'elenco Collegamento dell'endpoint.

      Se vuoi stabilire una connessione pubblica ai tuoi sistemi di backend con una maggiore sicurezza, puoi prendere in considerazione la configurazione di indirizzi IP statici in uscita per le tue connessioni, quindi configurare le regole del firewall in modo da inserire nella lista consentita solo gli indirizzi IP statici specifici.

      Per inserire destinazioni aggiuntive, fai clic su + AGGIUNGI DESTINAZIONE.

   2. Fai clic su AVANTI.
6. Nella sezione Autenticazione, inserisci i dettagli di autenticazione.
   • Seleziona un Tipo di autenticazione e inserisci i dettagli pertinenti.
   1. ID client: l'ID client utilizzato per richiedere i token di accesso.
   2. Ampiezze: un elenco separato da virgole degli ambiti desiderati
   3. Client secret: il secret di Secret Manager contenente il client secret per l'app collegata che hai creato.
   4. Versione: seleziona la versione dal menu a discesa e concedila.
   5. Fai clic su Avanti.
7. Rivedi: controlla i dettagli di connessione e autenticazione.
8. Fai clic su Crea.
9. Fai clic su Autorizza.

   Se l'autorizzazione va a buon fine, lo stato della connessione verrà impostato su Attivo nella pagina Connessioni.

Configura autenticazione

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

• Nome utente e password
  • Nome utente: nome utente per il connettore
  • Password: il segreto Secret Manager contenente la password associata al connettore.

Entità, operazioni e azioni

Tutti i connettori di integrazione forniscono un livello di astrazione per gli oggetti dell'applicazione collegata. Puoi accedere agli oggetti di un'applicazione solo tramite questa astrazione. L'astrazione viene mostrata come 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 un oggetto o una raccolta di proprietà nell'applicazione o nel servizio collegato. 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 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 abbia entità, nel qual caso l'elenco Entities sarà vuoto.

• Operazione : un'operazione è l'attività che puoi eseguire su un'entità. Puoi eseguire su un'entità una delle seguenti operazioni:
  • 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 sulle entità, queste operazioni non supportate 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. In genere, 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 le azioni è associato uno schema. Ad esempio, uno schema di azioni avrà i dettagli dei parametri, ad esempio i nomi dei parametri e il relativo tipo di dati. Lo schema (metadati) per le entità e le azioni viene recuperato dalla connessione al runtime dal tuo backend. Se sono presenti aggiornamenti allo schema, questi non verranno applicati automaticamente alle connessioni esistenti. Dovrai aggiornare manualmente lo schema. Per aggiornare lo schema di una connessione, apri la pagina Dettagli connessione della connessione e poi fai clic su Aggiorna schema connessione.

Limitazioni del sistema

Il connettore QuickBooks Online può elaborare una transazione al secondo per nodo e limita le transazioni che superano questo limite. Per impostazione predefinita, Integration Connectors alloca 2 nodi (per una maggiore disponibilità) per una connessione.

Per informazioni sui limiti applicabili a Integration Connectors, vedi Limiti.

Nota: il numero di nodi Integration Connectors verrà scalato automaticamente in base al tuo utilizzo. Tuttavia, se vuoi prenotare la capacità per volumi elevati senza dover attendere la scalabilità automatica, puoi modificare il valore del nodo minimo per una connessione. Per elaborare più transazioni per una connessione, sono necessari più nodi. Al contrario, sono necessari meno nodi se una connessione elabora meno transazioni. Per configurare i valori del nodo:

• Se sei un cliente con pagamento a consumo, configura il valore minimo e massimo del nodo nella pagina di modifica della connessione.
• Se sei un cliente con abbonamento, contatta l'assistenza.

Il numero massimo di transazioni che un nodo può gestire dipende da vari fattori. Pertanto, prima di modificare il numero minimo di nodi per migliorare il throughput, ti consigliamo di verificare se i sistemi di backend sono configurati in modo ottimale per gestire il traffico richiesto.

Esempi di operazioni sulle entità

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

Esempio: Elenca tutti gli account

Questo esempio elenca tutte le entità Accountassociated with the Current application of QB Online.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Accounts dall'elenco Entity.
3. Seleziona l'operazione List e poi 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. Specifica il valore della clausola di filtro sempre tra virgolette singole ("). Ad esempio, BillId='25'. Puoi anche specificare più condizioni di filtro utilizzando gli operatori logici. Ad esempio, BillId='25' and Active=false.

Esempio: ottieni un record

Questo esempio recupera un record con l'ID specificato dall'entità Bills.

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

   Qui, 220 è un valore della chiave primaria nell'entità Bills.

Esempio: crea un record

Questo esempio crea un record nell'entità Vendors.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Vendors 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 campo Default Value:

   {
   {
     {
       "Id": "32",
       "SyncToken": "0",
       "MetaData_CreateTime": "2024-04-17 17:13:24.0",
       "MetaData_LastUpdatedTime": "2024-04-24 19:55:23.0",
       "Title": null,
       "GivenName": null,
       "MiddleName": null,
       "FamilyName": null,
       "Suffix": null,
       "DisplayName": "tim Telephone",
       "CompanyName": "tim Telephone",
       "PrintOnCheckName": "tim Telephone",
       "Active": true,
       "PrimaryPhone_FreeFormNumber": "[phone]",
       "AlternatePhone_FreeFormNumber": null,
       "Mobile_FreeFormNumber": null,
       "Fax_FreeFormNumber": null,
       "PrimaryEmailAddr_Address": null,
       "WebAddr_URI": null,
       "BillAddr_Id": "33",
       "BillAddr_Line1": "10 Main St.",
       "BillAddr_Line2": null,
       "BillAddr_Line3": null,
       "BillAddr_Line4": null,
       "BillAddr_Line5": null,
       "BillAddr_City": "Palo Alto",
       "BillAddr_Country": null,
       "BillAddr_CountrySubDivisionCode": "CA",
       "BillAddr_PostalCode": "94303",
       "BillAddr_Lat": "37.445013",
       "BillAddr_Long": "-122.1391443",
       "OtherContactInfo_Type": null,
       "OtherContactInfo_Telephone_FreeFormNumber": null,
       "TaxIdentifier": null,
       "TermRef": "1",
       "TermRef_Name": null,
       "Balance": "0",
       "AcctNum": null,
       "Vendor1099": false,
       "CurrencyRef": "USD",
       "CurrencyRef_Name": "United States Dollar"
     }
   }

   Se l'integrazione è andata a buon fine, il campo connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

   {
   { "Id": "64" }
   }

Esempio: aggiorna un record

Questo esempio aggiorna il record con l'ID specificato nell'entità Purchases.

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

   {
   {
   "PrivateNote": "Update"
   }
   }

5. Fai clic su entityId e inserisci 22 nel campo Valore predefinito.

   Qui, 22 è un valore della chiave primaria nell'entità Purchases.

Esempio: eliminare un record

Questo esempio elimina il record con l'ID specificato nell'entità Invoices.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Invoices dall'elenco Entity.
3. Seleziona l'operazione Delete e fai clic su Fine.
4. Fai clic su entityId e inserisci 10 nel campo Valore predefinito.

   Qui, 10 è un valore della chiave primaria nell'entità Purchases.

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

   {
   {Success}
   }

Utilizzare la connessione a QuickBooks in un'integrazione

Una volta creata, la connessione diventa disponibile sia nell'integrazione Apigee sia nell'integrazione delle applicazioni. Puoi utilizzare la connessione in un'integrazione tramite l'attività Connettori.

• Per informazioni su come creare e utilizzare l'attività Connectors in Apigee Integration, consulta Attività Connectors.
• Per informazioni su come creare e utilizzare l'attività Connettori in Application Integration, consulta Attività Connettori.