FreshBooks

Le connecteur FreshBooks vous permet de vous connecter à une instance FreshBooks et d'accéder aux données de FreshBooks comme une base de données traditionnelle.

Versions compatibles

Ce connecteur modélise l'API FreshBooks Alpha en tant qu'objets de base de données pouvant être interrogés avec SQL.

Avant de commencer

Avant d'utiliser le connecteur Freshbooks, effectuez les tâches suivantes:

• Dans votre projet Google Cloud :
  • Activez les services suivants :
    • secretmanager.googleapis.com (API Secret Manager)
    • connectors.googleapis.com (API Connectors)

    Pour savoir comment activer des services, consultez la page Activer des services.

  Si ces services ou autorisations n'ont pas encore été activés pour votre projet, vous êtes invité à les activer lors de la configuration du connecteur.

Configurer le connecteur

Pour configurer le connecteur, vous devez créer une connexion à votre source de données (système backend). Une connexion est spécifique à une source de données. Cela signifie que si vous disposez de nombreuses sources de données, vous devez créer une connexion distincte pour chacune d'elles. Pour créer une connexion, procédez comme suit :

1. Dans la console Cloud, accédez à la page Integration Connectors > Connections (Connecteurs d'intégration > Connexions), puis sélectionnez ou créez un projet Google Cloud.

   Accéder à la page "Connexions"

2. Cliquez sur + Créer pour ouvrir la page Créer une connexion.
3. Dans la section Emplacement, choisissez l'emplacement de la connexion.
   1. Région : sélectionnez un emplacement dans la liste déroulante.

      Les régions disponibles pour les connecteurs sont les suivantes :

      Pour obtenir la liste de toutes les régions disponibles, consultez la section Emplacements.

   2. Cliquez sur Suivant.
4. Dans la section Détails de connexion, procédez comme suit :
   1. Connecteur: sélectionnez Freshbooks dans la liste déroulante des connecteurs disponibles.
   2. Version du connecteur : sélectionnez la version du connecteur dans la liste déroulante des versions disponibles.
   3. Dans le champ Nom de connexion, saisissez un nom pour l'instance de connexion.

      Les noms de connexion doivent répondre aux critères suivants :

      • Les noms de connexion peuvent contenir des lettres, des chiffres ou des traits d'union.
      • Les lettres doivent être en minuscules.
      • Les noms de connexion doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
      • Les noms de connexion ne peuvent pas dépasser 63 caractères.
   4. Saisissez éventuellement une Description pour l'instance de connexion.
   5. Compte de service : sélectionnez un compte de service disposant des rôles requis.
   6. Vous pouvez également configurer les paramètres du nœud de connexion :
      • Nombre minimal de nœuds : saisissez le nombre minimal de nœuds de connexion.
      • Nombre maximal de nœuds : saisissez le nombre maximal de nœuds de connexion.

      Un nœud est une unité (ou instance répliquée) de connexion qui traite des transactions. Pour traiter plus de transactions pour une connexion, plus de nœuds sont nécessaires. À l'inverse, moins de nœuds sont nécessaires pour traiter moins de transactions. Pour comprendre comment les nœuds affectent la tarification de votre connecteur, consultez la section Tarifs des nœuds de connexion. Si vous ne saisissez aucune valeur, le nombre minimal de nœuds est défini par défaut sur 2 (pour une meilleure disponibilité) et le nombre maximal sur 50.

   Remarque : Vous ne pouvez personnaliser les valeurs du nœud de connexion que si vous êtes un client facturé à l'usage.
   7. ID du compte: l'ID du compte auquel se connecter. Si aucune valeur n'est spécifiée, la première valeur renvoyée est utilisée.
   8. Vous pouvez également cliquer sur + Ajouter une étiquette pour ajouter une étiquette à la connexion sous la forme d'une paire clé/valeur.
   9. Cliquez sur Suivant.
5. Dans la section Authentification, saisissez les informations d'authentification.
   1. Sélectionnez un type d'authentification, puis saisissez les informations appropriées.

      Les types d'authentification suivants sont compatibles avec la connexion Freshbooks:

      • Octroi du code d'autorisation OAuth 2.0

   Pour comprendre comment configurer ces types d'authentification, consultez la section Configurer l'authentification.

   2. Cliquez sur Suivant.
6. Vérifiez vos informations de connexion et d'authentification.
7. Cliquez sur Créer.

Configurer l'authentification

Saisissez les détails en fonction de l'authentification que vous souhaitez utiliser.

• Octroi du code d'autorisation OAuth 2.0
  • Champs d'application: liste des champs d'application souhaités, séparés par une virgule.
  • ID client : ID client utilisé pour demander des jetons d'accès.
  • Code secret du client : code secret du client utilisé pour demander des jetons d'accès.

Entités, opérations et actions

Tous les connecteurs Integration Connectors fournissent une couche d'abstraction pour les objets de l'application connectée. Vous ne pouvez accéder aux objets d'une application que via cette abstraction. L'abstraction vous est présentée en tant qu'entités, opérations et actions.

Remarque : Vous pouvez afficher les entités, les opérations et les actions d'un connecteur dans la tâche Connecteurs.

• Entité : une entité peut être considérée comme un objet ou un ensemble de propriétés dans l'application ou le service connecté. La définition d'une entité diffère d'un connecteur à l'autre. Par exemple, dans un connecteur de base de données, les tables sont les entités, dans un connecteur de serveur de fichiers, les dossiers sont les entités et, dans un connecteur de système de messagerie, les files d'attente sont les entités.

  Toutefois, il est possible qu'un connecteur ne soit pas compatible ou ne possède aucune entité. Dans ce cas, la liste Entities est vide.

• Opération : une opération est l'activité que vous pouvez effectuer sur une entité. Vous pouvez effectuer l'une des opérations suivantes sur une entité :
  • Liste
  • Obtenir
  • créer
  • Mettre à jour
  • Supprimer

  La sélection d'une entité dans la liste disponible génère une liste d'opérations disponibles pour l'entité. Pour obtenir une description détaillée des opérations, consultez les opérations d'entité de la tâche de connecteur. Toutefois, si un connecteur n'accepte aucune des opérations d'entité, celles-ci ne sont pas répertoriées dans la liste Operations.

• Action : une action est une fonction de première classe mise à la disposition de l'intégration via l'interface du connecteur. Une action vous permet de modifier une ou plusieurs entités, et varie d'un connecteur à l'autre. Normalement, une action comporte des paramètres d'entrée et un paramètre de sortie. Toutefois, il est possible qu'un connecteur ne prenne en charge aucune action, auquel cas la liste Actions est vide.

Remarque : Toutes les entités et les actions seront associées à un schéma. Par exemple, un schéma d'action contiendra les détails des paramètres, tels que les noms des paramètres et le type de données correspondant. Le schéma (métadonnées) des entités et des actions est récupéré par la connexion au moment de l'exécution à partir de votre backend. Si le schéma est mis à jour, celles-ci ne seront pas automatiquement répercutées dans vos connexions existantes. Vous devez actualiser le schéma manuellement. Pour actualiser le schéma d'une connexion, ouvrez la page Détails de la connexion de la connexion, puis cliquez sur Actualiser le schéma de connexion.

Exemples d'opérations sur les entités

Cette section explique comment effectuer certaines opérations sur les entités dans ce connecteur.

Exemple : Répertorier tous les projets

Cet exemple répertorie tous les projets de l'entité Projects.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Projects dans la liste Entity.
3. Sélectionnez l'opération List, puis cliquez sur OK.
4. Si vous le souhaitez, dans la section Entrée de tâche de la tâche Connecteurs, vous pouvez filtrer l'ensemble de résultats en spécifiant une clause de filtre.

Exemple – Obtenir un enregistrement à partir d'une entité

Cet exemple récupère un enregistrement dont l'ID est 2009015 à partir de l'entité Expense Categories.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Expense Categories dans la liste Entity.
3. Sélectionnez l'opération Get, puis cliquez sur OK.
4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur EntityId (ID d'entité), puis saisissez 2009015 dans le champ Default Value (Valeur par défaut).

   Ici, 2009015 est une valeur de clé primaire dans l'entité Expense Categories.

Exemple : Créer une facture

Cet exemple crée une facture dans l'entité Invoices.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Invoices dans la liste Entity.
3. Sélectionnez l'opération Create, puis cliquez sur OK.
4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

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

   Si l'intégration réussit, le champ connectorOutputPayload de votre tâche de connecteur aura une valeur semblable à celle-ci:

   {
   "Id": "49594.0"
   }

Exemple : Mettre à jour une facture

Cet exemple met à jour la facture dont l'ID est 36741.0 dans l'entité Invoices.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Invoices dans la liste Entity.
3. Sélectionnez l'opération Update, puis cliquez sur OK.
4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "FirstName": "James"
   }

5. Cliquez sur entityId, puis saisissez 36741.0 dans le champ Valeur par défaut.

   Au lieu de spécifier entityId, vous pouvez également définir filterClause sur 36741.0.

   Si l'intégration réussit, le champ connectorOutputPayload de votre tâche de connecteur aura une valeur semblable à celle-ci:

   {
   "Id": "36741.0"
   }

Exemple : Supprimer un enregistrement

Cet exemple supprime l'enregistrement dont l'ID est 78 dans l'entité Payments.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Payments dans la liste Entity.
3. Sélectionnez l'opération Delete, puis cliquez sur OK.
4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur entityId, puis saisissez 78 dans le champ Default Value (Valeur par défaut).

Utiliser Terraform pour créer des connexions

Vous pouvez utiliser la ressource Terraform pour créer une connexion.

Pour savoir comment appliquer ou supprimer une configuration Terraform, consultez la page Commandes Terraform de base.

Pour afficher un exemple de modèle Terraform pour la création de connexions, consultez cet exemple de modèle.

Lorsque vous créez cette connexion à l'aide de Terraform, vous devez définir les variables suivantes dans votre fichier de configuration Terraform:

Nom du paramètre	Type de données	Obligatoire	Description
account_id	STRING	Vrai	ID du compte auquel se connecter. Si aucune valeur n'est spécifiée, la première valeur renvoyée est utilisée.

Utiliser la connexion Freshbooks dans une intégration

Une fois la connexion créée, elle devient disponible à la fois dans Apigee Integration et Application Integration. Vous pouvez utiliser la connexion dans une intégration via la tâche Connecteurs.

• Pour comprendre comment créer et utiliser la tâche "Connecteurs" dans Apigee Integration, consultez la section Tâche Connecteurs.
• Pour découvrir comment créer et utiliser la tâche "Connecteurs" dans Application Integration, consultez la section Tâche Connecteurs.

Obtenir de l'aide auprès de la communauté Google Cloud

Vous pouvez publier vos questions et discuter de ce connecteur sur les forums Cloud de la communauté Google Cloud.

Étapes suivantes

• Découvrez comment suspendre et réactiver une connexion.
• Découvrez comment surveiller l'utilisation des connecteurs.
• Découvrez comment afficher les journaux du connecteur.