Freshbook

Il connettore FreshBooks ti consente di connetterti a un'istanza 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 che è possibile interrogare con SQL.

Prima di iniziare

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

• Nel tuo progetto Google Cloud:
  • Attiva i seguenti servizi:
    • secretmanager.googleapis.com (API Secret Manager)
    • connectors.googleapis.com (API Connectors)

    Per informazioni su come abilitare i servizi, vedi Attivazione 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.

Per informazioni su come creare un'applicazione e generare ID client e client secret per l'autenticazione, consulta la guida introduttiva all'API FreshBooks.

Configura il connettore

Per configurare il connettore devi creare una connessione all'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 nuovo per aprire la pagina Crea connessione.
3. Nella sezione Posizione, 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 aree geografiche supportate, consulta la sezione Località.

   2. Fai clic su Avanti.
4. Nella sezione Dettagli connessione, completa quanto segue:
   1. Connettore: seleziona Freshbooks 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. Facoltativamente, 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, al contrario, 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 migliore disponibilità) e il numero massimo di nodi è impostato su 50.

   Nota: puoi personalizzare i valori del nodo di connessione solo se un cliente con pagamento a consumo.
   8. ID account: l'ID account a cui connetterti. Se non viene specificato un valore, verrà utilizzato il primo restituito.
   9. Facoltativamente, 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.

      La connessione Freshbooks supporta i seguenti tipi di autenticazione:

      • Concessione del codice di autorizzazione OAuth 2.0

   Per capire come configurare questi tipi di autenticazione, consulta 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
  • Ampiezze: 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 a FreshBooks:

1. Dalla pagina Connessioni,fai clic sul collegamento di FreshBooks.
2. Nella sezione Autenticazione, fai clic su Autorizza connessione.
3. Vai alla sezione URI di reindirizzamento e copialo.
4. Nell'applicazione FreshBooks, fai clic su Reindirizza URI.
5. Incolla l'URI di reindirizzamento che hai copiato dalla connessione a FreshBooks e poi fai clic su Salva impostazioni.
6. Torna alla connessione FreshBooks e fai clic su Autorizza nella sezione di autenticazione.

   Se l'autorizzazione ha esito positivo, lo stato della connessione verrà impostato su Attivo nella Pagina Connessioni.

Entità, operazioni e azioni

Tutti i connettori di integrazione forniscono un livello di astrazione per gli oggetti l'applicazione connessa. 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 un insieme di proprietà nel un'applicazione o un servizio connesso. 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 abbia entità, nel qual 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

  Selezionando un'entità dall'elenco disponibile, viene generato un elenco di operazioni disponibili per l'entità. Per una descrizione dettagliata delle operazioni, consulta operazioni relative a entità. 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 consente di apportare modifiche a una o più entità variano da connettore a connettore. 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 entità e azioni viene recuperato dalla connessione in 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.

Esempi di operazioni con entità

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

Esempio: elenca tutti i progetti

In questo esempio sono elencati tutti i progetti nell'entità Projects.

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

Esempio: ottieni un record da un'entità

Questo esempio recupera un record il cui ID è 2009015 dall'entità Expense Categories.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Expense Categories dall'elenco Entity.
3. Seleziona l'operazione Get e poi fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su EntityId e quindi inserisci 2009015 nel campo Valore predefinito.

   In questo caso, 2009015 è un valore di chiave primaria nell'entità Expense Categories.

Esempio - Creazione di una fattura

Questo esempio crea una fattura 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 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 Default Value campo:

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

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

   {
   "Id": "49594.0"
   }

Esempio: aggiornare una fattura

Questo esempio aggiorna la fattura il cui ID è 36741.0 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 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:

   {
   "FirstName": "James"
   }

5. Fai clic su entityId e inserisci 36741.0 nel campo Default Value (Valore predefinito).

   In alternativa, invece di specificare entityId, puoi anche impostare il parametro filterClause su 36741.0.

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

   {
   "Id": "36741.0"
   }

Esempio: eliminare un record

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

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

Utilizzare Terraform per creare connessioni

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, vedi il 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 connetterti. 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 in Apigee Integration e Application Integration. 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.

Ricevere assistenza dalla community Google Cloud

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

Passaggi successivi

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