QuickBooks Online

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

Prima di iniziare

Prima di utilizzare il connettore QuickBooks Online, esegui 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 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. Per maggiori 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 queste 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 origine dati. Per creare una connessione:

  1. Nella console 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 NUOVA per aprire la pagina Crea connessione.
  3. Nella sezione Località, scegli la località per la 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 contenere più di 49 caratteri.
    4. (Facoltativo) Inserisci una Descrizione per l'istanza di connessione.
    5. Service Account: 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. 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 la sezione 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 su 50.

    7. ID azienda: fornisci l'ID azienda dell'app registrata nel portale per sviluppatori Intuit.
    8. (Facoltativo) Inserisci un codice paese: per la versione di QuickBooks Online in uso.
    9. (Facoltativo) Inserisci una versione secondaria: da utilizzare quando invii richieste all'API QuickBooks Online.
    10. Utilizza Sandbox: fai clic sulla casella di controllo se utilizzi un account sandbox.
    11. (Facoltativo) Nella sezione Impostazioni avanzate, seleziona la casella di controllo Usa proxy per configurare un server proxy per la connessione e configura i seguenti valori:
      • Proxy Auth Scheme: seleziona il tipo di autenticazione per l'autenticazione con il server proxy. Sono supportati i seguenti tipi di autenticazione:
        • Basic: 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 secret di Secret Manager della password dell'utente.
      • Tipo di SSL proxy: il tipo di SSL da utilizzare per la connessione al server proxy. Sono supportati i seguenti tipi di autenticazione:
        • Automatica: impostazione predefinita. Se l'URL è un URL HTTPS, viene utilizzata l'opzione Tunnel. Se l'URL è un URL HTTP, viene utilizzata l'opzione NEVER.
        • 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 scorre 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:

    12. (Facoltativo) Fai clic su + AGGIUNGI ETICHETTA 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.
      • Per specificare il nome host o l'indirizzo IP di destinazione, seleziona Indirizzo host e inserisci l'indirizzo nel campo Host 1.
      • Per stabilire una connessione privata, seleziona Collegamento endpoint e scegli il collegamento richiesto dall'elenco Collegamento endpoint.

      Se vuoi stabilire una connessione pubblica ai tuoi sistemi di backend con maggiore sicurezza, puoi valutare la possibilità di configurare indirizzi IP statici in uscita per le tue connessioni e poi configurare le regole del firewall in modo da consentire solo gli indirizzi IP statici specifici.

      Per inserire altre destinazioni, 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. Scopes: un elenco separato da virgole degli ambiti desiderati
      3. Client secret: secret di Secret Manager contenente il client secret per l'app connessa che hai creato.
      4. Versione: seleziona la versione dal menu a discesa e concedi l'accesso.
      5. Fai clic su Avanti.
  7. Rivedi: rivedi 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 Attiva nella pagina Connessioni.

Configura l'autenticazione

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

  • Nome utente e password
    • Nome utente: nome utente per il connettore
    • Password: il secret di 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 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.

Limitazioni di sistema

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

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

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

    In questo caso, 220 è un valore della chiave primaria nell'entità Bills.

Esempio: creare 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, 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: 
    {
{
  {
    "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": "(650) 555-1616",
    "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 ha esito positivo, il campo connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

    {
{ "Id": "64" }
}

Esempio: aggiornare 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, 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: 
    {
{
"PrivateNote": "Update"
}
}
  5. Fai clic su entityId, quindi inserisci 22 nel campo Valore predefinito.

    In questo caso, 22 è un valore della chiave primaria nell'entità Purchases.

Esempio: elimina 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, quindi fai clic su Fine.
  4. Fai clic su entityId, quindi inserisci 10 nel campo Valore predefinito.

    In questo caso, 10 è un valore della chiave primaria nell'entità Purchases.

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

    {
{Success}
}

Utilizzare la connessione QuickBooks 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, consulta Attività Connettori.