Freshbooks

Il connettore FreshBooks ti consente di connetterti a un'istanza di FreshBooks e di accedere ai dati di FreshBooks come a un database tradizionale.

Versioni supportate

Questo connettore modella l'API FreshBooks Alpha come oggetti di database su cui è possibile eseguire query con SQL.

Prima di iniziare

Prima di utilizzare il connettore Freshbooks, esegui le seguenti attività:

• Nel progetto Google Cloud:
  • Assicurati che la connettività di rete sia configurata. Per informazioni sui pattern di rete, consulta Connettività di rete.
  • Attiva i seguenti servizi:
    • secretmanager.googleapis.com (API Secret Manager)
    • connectors.googleapis.com (Connettori API)

    Per scoprire come attivare i servizi, consulta Attivare i 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.

Per informazioni su come creare un'applicazione e generare l'ID client e il client secret per l'autenticazione, consulta Inizia a utilizzare l'API FreshBooks.

Configurare il connettore

Una connessione è specifica per un'origine dati. Ciò 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 Integration Connectors > 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à 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 regioni supportate, consulta Località.

   2. Fai clic su Avanti.
4. Nella sezione Dettagli connessione, completa i seguenti passaggi:
   1. Connettore: seleziona Freshbooks 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 49 caratteri.
   4. (Facoltativo) Inserisci una Descrizione per l'istanza di connessione.
   5. (Facoltativo) Attiva Cloud Logging e 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 maggiore disponibilità) e i nodi massimi sono impostati su 50.

   Nota: puoi personalizzare i valori dei nodi di connessione solo se sei un cliente con pagamento a consumo.
   8. ID account: l'ID account a cui connettersi. Se non viene specificato un valore, verrà utilizzato il primo restituito.
   9. (Facoltativo) Fai clic su + Aggiungi etichetta per aggiungere un'etichetta alla connessione sotto forma di coppia chiave-valore.
   10. Fai clic su Avanti.
5. Nella sezione Autenticazione, inserisci i dettagli di autenticazione.
   1. Seleziona un Tipo di autenticazione e inserisci i dettagli pertinenti.

      I seguenti tipi di autenticazione sono supportati dalla connessione Freshbooks:

      • Concessione del codice di autorizzazione OAuth 2.0

   Per scoprire come configurare questi tipi di autenticazione, consulta Configurare l'autenticazione.

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

Configurare l'autenticazione

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

• Concessione del codice di autorizzazione OAuth 2.0
  • Ambiti: un elenco separato da virgole degli ambiti desiderati.
  • ID client: l'ID client utilizzato per richiedere i token di accesso.
  • Client secret: il client secret utilizzato per richiedere i token di accesso.

Per autorizzare la connessione FreshBooks:

1. Nella pagina Connessioni, fai clic sulla connessione FreshBooks.
2. Nella sezione Autenticazione, fai clic su Autorizza connessione.
3. Vai alla sezione URI di reindirizzamento e copiala.
4. Nell'applicazione FreshBooks, fai clic su URI di reindirizzamento.
5. Incolla l'URI di reindirizzamento che hai copiato dalla connessione FreshBooks e fai clic su Salva impostazioni.
Quando configuri l'applicazione OAuth di terze parti, utilizza questo URI di reindirizzamento autorizzato (URL di callback):

https://console.cloud.google.com//connectors/oauth?project=PROJECT_ID

Sostituisci PROJECT_ID con l'ID progetto Google Cloud .

6. Torna alla connessione FreshBooks e fai clic su Autorizza nella sezione di autenticazione.

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

Entità, operazioni e azioni

Tutti gli Integration Connectors 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 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 connesso. La definizione di un'entità varia da connettore a connettore. 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' Entities sarà vuoto.

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

  Se selezioni un'entità dall'elenco disponibile, viene generato un elenco di operazioni disponibili per l'entità. Per una descrizione dettagliata delle operazioni, consulta Operazioni sulle entità dell'attività Connettori . Tuttavia, se un connettore non supporta nessuna delle operazioni sulle entità, le operazioni non supportate non vengono 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 avrà alcuni parametri di input e un parametro di output parametro. Tuttavia, è possibile che un connettore non supporti alcuna azione, nel qual caso l'elenco Actions sarà vuoto.

Nota: tutte le entità e le azioni avranno uno schema associato. Ad esempio, uno schema di azione avrà i dettagli dei parametri, ad esempio i nomi dei parametri e il tipo di dati corrispondente. Lo schema (metadati) per entità e azioni viene recuperato dalla connessione in fase di runtime dal backend. Se vengono apportati aggiornamenti allo schema, questi non verranno applicati automaticamente alle 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 schema connessione.

Esempi di operazioni sulle entità

In questa sezione viene illustrato come eseguire alcune delle operazioni sulle entità in questo connettore.

Esempio: elencare tutti i progetti

Questo esempio elenca tutti i progetti nell'entità Projects.

1. Nella finestra di dialogo Configure connector task (Configura attività connettore), fai clic su Entities (Entità).
2. Seleziona Projects (Progetti) dall'elenco Entity (Entità).
3. Seleziona l'operazione List e fai clic su Fine.
4. (Facoltativo) Nella sezione Task Input (Input attività) dell'attività Connettori , puoi filtrare il set di risultati specificando una clausola di filtro.

Esempio: recuperare un record da un'entità

Questo esempio recupera un record il cui ID è 2009015 dall'entità Expense Categories (Categorie di spesa).

1. Nella finestra di dialogo Configure connector task (Configura attività connettore), fai clic su Entities (Entità).
2. Seleziona Expense Categories (Categorie di spesa) dall'elenco Entity (Entità).
3. Seleziona l'operazione Get e fai clic Fine.
4. Nella sezione Task Input (Input attività) dell'attività Connectors, fai clic su EntityId e inserisci 2009015 nel campo Default Value (Valore predefinito).

   Qui, 2009015 è un valore della chiave primaria nell'entità Expense Categories (Categorie di spesa).

Esempio: creare una fattura

Questo esempio crea una fattura nell'entità Invoices (Fatture).

1. Nella finestra di dialogo Configure connector task (Configura attività connettore), fai clic su Entities (Entità).
2. Seleziona Invoices (Fatture) dall'elenco Entity (Entità).
3. Seleziona l'operazione Create (Crea) e fai clic su Fine.
4. Nella sezione Task Input (Input attività) dell'attività Connectors, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value (Valore predefinito):

   {"CustomerId": 68039.0,
   "FirstName": "John",
   "CreateDate": "2023-09-13"
   }

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

   {
   "Id": "49594.0"
   }

Esempio: aggiornare una fattura

Questo esempio aggiorna la fattura il cui ID è 36741.0 nell'entità Invoices (Fatture).

1. Nella finestra di dialogo Configure connector task (Configura attività connettore), fai clic su Entities (Entità).
2. Seleziona Invoices (Fatture) dall'elenco Entity (Entità).
3. Seleziona l'operazione Update (Aggiorna) e fai clic su Fine.
4. Nella sezione Task Input (Input attività) dell'attività Connectors, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value (Valore predefinito):

   {
   "FirstName": "James"
   }

5. Fai clic su entityId e inserisci 36741.0 nel campo Default Value.

   In alternativa, anziché specificare entityId, puoi anche impostare filterClause su 36741.0.

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

   {
   "Id": "36741.0"
   }

Esempio: eliminare un record

Questo esempio elimina il record il cui ID è 78 nell'entità Payments (Pagamenti).

1. Nella finestra di dialogo Configure connector task (Configura attività connettore), fai clic su Entities (Entità).
2. Seleziona Payments (Pagamenti) dall'elenco Entity (Entità).
3. Seleziona l'operazione Delete (Elimina) e fai clic su Fine.
4. Nella sezione Task Input (Input attività) dell'attività Connectors, fai clic su entityId e inserisci 78 nel campo Default Value (Valore predefinito).

Creare connessioni utilizzando Terraform

Puoi utilizzare la risorsa Terraform per creare una nuova connessione.

Per scoprire come applicare o rimuovere una configurazione Terraform, consulta Comandi Terraform di base.

Per visualizzare un modello Terraform di esempio per la creazione di connessioni, consulta Modello di esempio.

Quando crei questa connessione utilizzando Terraform, devi impostare le seguenti variabili nel file di configurazione Terraform:

Nome parametro	Tipo di dati	Obbligatorio	Descrizione
account_id	STRING	Vero	L'ID account a cui connettersi. Se non viene specificato un valore, verrà utilizzato il primo restituito.

Utilizzare la connessione Freshbooks in un'integrazione

Dopo aver creato 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 scoprire come creare e utilizzare l'attività Connettori in Apigee Integration, consulta Attività Connettori.
• Per scoprire come creare e utilizzare l'attività Connettori in Application Integration, consulta Attività Connettori.

Chiedere assistenza alla community di Google Cloud

Puoi pubblicare le tue domande e discutere di questo connettore nella community di Google Cloud nei forum di Cloud.

Passaggi successivi

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